AlphaOTT API (1.3.0)

Download OpenAPI specification:Download

Flow:

Get app config
- Use public/private url from config.json as API endpoint
Login or Register to get authentication token
- Use access_token in Authorization header
Get customer
Get promos by customer.services[i].type === ['LIVE_TV', 'CATCHUP_TV', 'RADIO', 'VOD', 'APPS']
Get subscriptions - {private_api}/client/api/subscriptions (not described yet in Docs)
Get service-provider - {public_api}/client/api/service-provider (not described yet in Docs)
Get customer device limits every config.limits.interval seconds while a user watches tv/movie content (only if a feature is switched on config.limits.enabled)
Get channels by customer.services[i].type === 'LIVE_TV'
- Get channel categories by customer.services[i].type === 'LIVE_TV'
- Get channel countries by customer.services[i].type === 'LIVE_TV'
- Get channel genres by customer.services[i].type === 'LIVE_TV'
- Get channel languages by customer.services[i].type === 'LIVE_TV'
- Get channel sources to get media urls
- Get channel programs to get list of programs
Get movies by customer.services[i].type === 'VOD'
- Get movie countries by customer.services[i].type === 'VOD'
- Get movie categories by customer.services[i].type === 'VOD'
- Get movie genres by customer.services[i].type === 'VOD'
- Get movie languages by customer.services[i].type === 'VOD'
- Get movie detail to get detail information
- Get movie sources to get media urls
- Get movie trailer sources to get trailer deatil information & trailer media urls
Update user profile
Change user password

Core

App Config

Get app config

Responses

Response samples

200
451

Content type

application/json

{"ui": {"theme": "alphaott",
"tv": {"catalog": {"exclude": "favorites,latest,top,genres,countries"
}
}
},
"api": {"public": {"url": "http://mw.alphaott.com"
},
"private": {"url": "https://mw.alphaott.com"
}
},
"verification": {"url": "http://alphaott.com/device"
},
"content": {"url": "http://mw.cdn.alphaott.com/content/images/"
},
"limits": {"enabled": "true",
"interval": "60"
},
"ad": {"enabled": true
},
"billing": {"enabled": true
},
"epg": {"enabled": true
}
}

API Version

Responses

Response samples

200

Content type

application/json

{"version": "1.1.8"
}

System Status

Responses

Response samples

200

Content type

application/json

{"status": "OK"
}

checkCustomerDeviceLimits Deprecated

Use /client/api/customer/device/online instead of /client/api/stats/impression

Authorizations:

JWT

query Parameters

contentId	string Example: contentId=5915c3e3201c2313ee14be2f Content ID
contentType	string Enum: "tv" "vod" Example: contentType=tv Content Type

Responses

Response samples

200
400
403

Content type

application/json

{"status": "OK"
}

Get country list

Responses

Response samples

200

Content type

application/json

[{"_id": "GRC",
"commonName": "Greece"
}
]

Get Cities List

query Parameters

region

string

Example: region=AL

Region ID

Responses

Response samples

200

Content type

application/json

[{"name": "Adamsville",
"native": "Adamsville",
"latitude": 33.60094,
"longitude": -86.95611,
"population": 0,
"area": 0,
"region": "AL",
"country": "USA"
}
]

Get Regions List

Responses

Response samples

200

Content type

application/json

[{"name": "Alabama",
"native": "Alabama",
"latitude": 0,
"longitude": 0,
"population": 0,
"area": 0,
"code": "AL",
"country": "USA"
}
]

checkCustomerDeviceLimits

Authorizations:

JWT

query Parameters

contentId	string Example: contentId=5915c3e3201c2313ee14be2f Content ID
contentType	string Enum: "tv" "vod" "tvShow" "catchUp" Example: contentType=tv Content Type

Responses

Response samples

200
400
403

Content type

application/json

{"status": "OK"
}

Auth

Authentication methods for the specific device

query Parameters

device[id] required	string (_id) Example: device[id]=4e8e8494-ef9f-4bc1-9c65-31ef1e372f05 Device ID
device[type] required	string (type) Enum: "UNKNOWN" "STB" "PC" "TV" "MOBILE" "TABLET" Example: device[type]=UNKNOWN Device type
device[model] required	string (model) Example: device[model]=Gecko Device model
device[platform] required	string (platform) Example: device[platform]=BROWSER Device platform
device[brand] required	string (brand) Example: device[brand]=Google Inc. Device brand
device[serial] required	string (serial) Example: device[serial]=23831B2EBD5BA09F Device serial
device[mac] required	string (mac) Example: device[mac]=FD:8D:73:34:CF:BE:BE:56 Device mac address

Responses

Response samples

200
400

Content type

application/json

{"isNew": true,
"authMethods": ["PASSWORD",
"VOUCHER",
"QR_CODE",
"FIREBASE",
"OTP_EMAIL"
],
"signupMethods": ["EMAIL",
"OTP_EMAIL",
"OTP_SMS"
]
}

User Authorization

Authorizations:

JWT

Request Body schema: application/json

One of

response_type	string Value: "code"
response_mode	string Default: "json" Enum: "query" "fragment" "form_post" "json" "redirect"
client_id	string
client_secret	string
scope	string Value: "client-api"
state	string The state string, which service returns without making any changes. The maximum length of the string is 1024 characters. You can use it for protection from CSRF attacks or for identifying the user that a token is requested for
	object (Device)

Responses

Request samples

Payload

Content type

application/json

{"response_type": "code",
"response_mode": "query",
"client_id": "Ok8Bc3fsJ4Dg0dh6bDH9bd8wg1gcet",
"client_secret": "PodF2Bfe4D6Bfbdi4uYt6ee9DURIfy7IguIgRd",
"scope": "client-api",
"state": "xyz",
"device": {"_id": "4e8e8494-ef9f-4bc1-9c65-31ef1e372f05",
"type": "UNKNOWN",
"model": "Gecko",
"platform": "BROWSER",
"brand": "Google Inc.",
"serial": "23831B2EBD5BA09F",
"mac": "FD:8D:73:34:CF:BE:BE:56"
}
}

Response samples

200
400
451

Content type

application/json

{"expires_in": 300,
"code": "74tq5miHKB",
"uri": "https://tv.alphaott.com/auth/authorize?code=74tq5miHKB"
}

OTP Authorization

Request Body schema: application/json

One of

email required	string <email> "OTP_EMAIL" auth-method
client_id required	string
client_secret required	string
required	object (Device)

Responses

Request samples

Payload

Content type

application/json

Example

Email

{"email": "oliver.queen@mail.com",
"client_id": "Ok8Bc3fsJ4Dg0dh6bDH9bd8wg1gcet",
"client_secret": "PodF2Bfe4D6Bfbdi4uYt6ee9DURIfy7IguIgRd",
"device": {"_id": "4e8e8494-ef9f-4bc1-9c65-31ef1e372f05",
"type": "UNKNOWN",
"model": "Gecko",
"platform": "BROWSER",
"brand": "Google Inc.",
"serial": "23831B2EBD5BA09F",
"mac": "FD:8D:73:34:CF:BE:BE:56"
}
}

Response samples

200
400
429

Content type

application/json

{"access_token": "TMWo0FsAENON0JA8AIlkn37FJMwj3uAa",
"token_type": "OTP",
"expires_in": "2021-04-26T13:36:51.380Z",
"remain_resend": 2,
"remain_attempt": 3
}

Authorization Token Exchange

Request Body schema: application/json

One of

grant_type	string Value: "password"
password	string <password>
username	string <email>
client_id	string
client_secret	string
	object (Device)

Responses

Request samples

Payload

Content type

application/json

Example

token.password.request

{"grant_type": "password",
"password": "password",
"username": "example@mail.com",
"client_id": "Ok8Bc3fsJ4Dg0dh6bDH9bd8wg1gcet",
"client_secret": "PodF2Bfe4D6Bfbdi4uYt6ee9DURIfy7IguIgRd",
"device": {"_id": "4e8e8494-ef9f-4bc1-9c65-31ef1e372f05",
"type": "UNKNOWN",
"model": "Gecko",
"platform": "BROWSER",
"brand": "Google Inc.",
"serial": "23831B2EBD5BA09F",
"mac": "FD:8D:73:34:CF:BE:BE:56"
}
}

Response samples

200
400
404
429
451

Content type

application/json

{"expires_in": 300,
"token_type": "JWT",
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfaWQiOiJPazhCYzNmc0o0RGcwZGg2YkRIOWJkOHdnMWdjZXQiLCJjbGllbnRfaXAiOiI6OjEiLCJkZXZpY2UiOnsiX2lkIjoiNGU4ZTg0OTQtZWY5Zi00YmMxLTljNjUtMzFlZjFlMzcyZjA1IiwidHlwZSI6IlVOS05PV04iLCJwbGF0Zm9ybSI6IkJST1dTRVIiLCJzZXJpYWwiOiJEQTA5NEI5NTA2MDhEOEJBIiwibWFjIjoiODI6OTA6QTg6NTk6RDI6QjE6QzA6NzYifSwiZ3JhbnRfc2NvcGUiOiJjbGllbnQtYXBpIiwiZ3JhbnRfdHlwZSI6ImFjY2Vzc190b2tlbiIsImlhdCI6MTU0Mjc3OTkzNywiZXhwIjoxNTQyNzgwMjM3LCJhdWQiOiJ6YWFwdHYiLCJpc3MiOiJjbG91ZGFudGVubmUuY2giLCJzdWIiOiI1YmY0ZjQyMWY3MTZjZjJiZTk1NzE1MDkiLCJqdGkiOiJOWjJUSUNMWUpIMTRBSEtuIn0.iqVLPtqkpQTV9l93y6GGwN7KfNMc86smhg3Ol9MHt2g",
"refresh_token": "JWT:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfaWQiOiJPazhCYzNmc0o0RGcwZGg2YkRIOWJkOHdnMWdjZXQiLCJkZXZpY2UiOnsiX2lkIjoiNGU4ZTg0OTQtZWY5Zi00YmMxLTljNjUtMzFlZjFlMzcyZjA1IiwidHlwZSI6IlVOS05PV04iLCJwbGF0Zm9ybSI6IkJST1dTRVIiLCJzZXJpYWwiOiJEQTA5NEI5NTA2MDhEOEJBIiwibWFjIjoiODI6OTA6QTg6NTk6RDI6QjE6QzA6NzYifSwiZ3JhbnRfc2NvcGUiOiJjbGllbnQtYXBpIiwiZ3JhbnRfdHlwZSI6InJlZnJlc2hfdG9rZW4iLCJpYXQiOjE1NDI3Nzk5MzcsImV4cCI6MTU0MzM4NDczNywiYXVkIjoiemFhcHR2IiwiaXNzIjoiY2xvdWRhbnRlbm5lLmNoIiwic3ViIjoiNWJmNGY0MjFmNzE2Y2YyYmU5NTcxNTA5IiwianRpIjoiTloyVElDTFlKSDE0QUhLbiJ9.VUs5sxSd1c49lxA00tA4dPPMmIlrfLx9Qh38CY6qeY0",
"id_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfaWQiOiJPazhCYzNmc0o0RGcwZGg2YkRIOWJkOHdnMWdjZXQiLCJjbGllbnRfaXAiOiI6OjEiLCJkZXZpY2UiOnsiX2lkIjoiNGU4ZTg0OTQtZWY5Zi00YmMxLTljNjUtMzFlZjFlMzcyZjA1IiwidHlwZSI6IlVOS05PV04iLCJwbGF0Zm9ybSI6IkJST1dTRVIiLCJzZXJpYWwiOiJEQTA5NEI5NTA2MDhEOEJBIiwibWFjIjoiODI6OTA6QTg6NTk6RDI6QjE6QzA6NzYifSwiZ3JhbnRfc2NvcGUiOiJjbGllbnQtYXBpIiwiZ3JhbnRfdHlwZSI6ImFjY2Vzc190b2tlbiIsImlhdCI6MTU0Mjc3OTkzNywiZXhwIjoxNTQyNzgwMjM3LCJhdWQiOiJ6YWFwdHYiLCJpc3MiOiJjbG91ZGFudGVubmUuY2giLCJzdWIiOiI1YmY0ZjQyMWY3MTZjZjJiZTk1NzE1MDkiLCJqdGkiOiJOWjJUSUNMWUpIMTRBSEtuIn0.iqVLPtqkpQTV9l93y6GGwN7KfNMc86smhg3Ol9MHt2g"
}

Sign up

Request Body schema: application/json

password	string <password> Clients should confirm password on their side
email	string <email>
client_id	string
client_secret	string
	object (Device)

Responses

Request samples

Payload

Content type

application/json

{"password": "password",
"email": "oliver.queen@mail.com",
"client_id": "Ok8Bc3fsJ4Dg0dh6bDH9bd8wg1gcet",
"client_secret": "PodF2Bfe4D6Bfbdi4uYt6ee9DURIfy7IguIgRd",
"device": {"_id": "4e8e8494-ef9f-4bc1-9c65-31ef1e372f05",
"type": "UNKNOWN",
"model": "Gecko",
"platform": "BROWSER",
"brand": "Google Inc.",
"serial": "23831B2EBD5BA09F",
"mac": "FD:8D:73:34:CF:BE:BE:56"
}
}

Response samples

200
400

Content type

application/json

{"expires_in": 300,
"token_type": "JWT",
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfaWQiOiJPazhCYzNmc0o0RGcwZGg2YkRIOWJkOHdnMWdjZXQiLCJjbGllbnRfaXAiOiI6OjEiLCJkZXZpY2UiOnsiX2lkIjoiNGU4ZTg0OTQtZWY5Zi00YmMxLTljNjUtMzFlZjFlMzcyZjA1IiwidHlwZSI6IlVOS05PV04iLCJwbGF0Zm9ybSI6IkJST1dTRVIiLCJzZXJpYWwiOiJEQTA5NEI5NTA2MDhEOEJBIiwibWFjIjoiODI6OTA6QTg6NTk6RDI6QjE6QzA6NzYifSwiZ3JhbnRfc2NvcGUiOiJjbGllbnQtYXBpIiwiZ3JhbnRfdHlwZSI6ImFjY2Vzc190b2tlbiIsImlhdCI6MTU0Mjc3OTkzNywiZXhwIjoxNTQyNzgwMjM3LCJhdWQiOiJ6YWFwdHYiLCJpc3MiOiJjbG91ZGFudGVubmUuY2giLCJzdWIiOiI1YmY0ZjQyMWY3MTZjZjJiZTk1NzE1MDkiLCJqdGkiOiJOWjJUSUNMWUpIMTRBSEtuIn0.iqVLPtqkpQTV9l93y6GGwN7KfNMc86smhg3Ol9MHt2g",
"refresh_token": "JWT:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfaWQiOiJPazhCYzNmc0o0RGcwZGg2YkRIOWJkOHdnMWdjZXQiLCJkZXZpY2UiOnsiX2lkIjoiNGU4ZTg0OTQtZWY5Zi00YmMxLTljNjUtMzFlZjFlMzcyZjA1IiwidHlwZSI6IlVOS05PV04iLCJwbGF0Zm9ybSI6IkJST1dTRVIiLCJzZXJpYWwiOiJEQTA5NEI5NTA2MDhEOEJBIiwibWFjIjoiODI6OTA6QTg6NTk6RDI6QjE6QzA6NzYifSwiZ3JhbnRfc2NvcGUiOiJjbGllbnQtYXBpIiwiZ3JhbnRfdHlwZSI6InJlZnJlc2hfdG9rZW4iLCJpYXQiOjE1NDI3Nzk5MzcsImV4cCI6MTU0MzM4NDczNywiYXVkIjoiemFhcHR2IiwiaXNzIjoiY2xvdWRhbnRlbm5lLmNoIiwic3ViIjoiNWJmNGY0MjFmNzE2Y2YyYmU5NTcxNTA5IiwianRpIjoiTloyVElDTFlKSDE0QUhLbiJ9.VUs5sxSd1c49lxA00tA4dPPMmIlrfLx9Qh38CY6qeY0",
"id_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfaWQiOiJPazhCYzNmc0o0RGcwZGg2YkRIOWJkOHdnMWdjZXQiLCJjbGllbnRfaXAiOiI6OjEiLCJkZXZpY2UiOnsiX2lkIjoiNGU4ZTg0OTQtZWY5Zi00YmMxLTljNjUtMzFlZjFlMzcyZjA1IiwidHlwZSI6IlVOS05PV04iLCJwbGF0Zm9ybSI6IkJST1dTRVIiLCJzZXJpYWwiOiJEQTA5NEI5NTA2MDhEOEJBIiwibWFjIjoiODI6OTA6QTg6NTk6RDI6QjE6QzA6NzYifSwiZ3JhbnRfc2NvcGUiOiJjbGllbnQtYXBpIiwiZ3JhbnRfdHlwZSI6ImFjY2Vzc190b2tlbiIsImlhdCI6MTU0Mjc3OTkzNywiZXhwIjoxNTQyNzgwMjM3LCJhdWQiOiJ6YWFwdHYiLCJpc3MiOiJjbG91ZGFudGVubmUuY2giLCJzdWIiOiI1YmY0ZjQyMWY3MTZjZjJiZTk1NzE1MDkiLCJqdGkiOiJOWjJUSUNMWUpIMTRBSEtuIn0.iqVLPtqkpQTV9l93y6GGwN7KfNMc86smhg3Ol9MHt2g"
}

Sign up with OTP

Request Body schema: application/json

password	string <password> Clients should confirm password on their side
email	string <email>
client_id	string
client_secret	string
firstName	string
lastName	string
middleName	string
prefix	string
suffix	string
phones	Array of strings
	object (Device)
	object (Address)
	object (Address)

Responses

Request samples

Payload

Content type

application/json

{"password": "password",
"email": "oliver.queen@mail.com",
"client_id": "Ok8Bc3fsJ4Dg0dh6bDH9bd8wg1gcet",
"client_secret": "PodF2Bfe4D6Bfbdi4uYt6ee9DURIfy7IguIgRd",
"firstName": "John",
"lastName": "Smith",
"middleName": "Oliver",
"prefix": "Mr",
"suffix": "",
"phones": ["+ 0000 0000 0000"
],
"device": {"_id": "4e8e8494-ef9f-4bc1-9c65-31ef1e372f05",
"type": "UNKNOWN",
"model": "Gecko",
"platform": "BROWSER",
"brand": "Google Inc.",
"serial": "23831B2EBD5BA09F",
"mac": "FD:8D:73:34:CF:BE:BE:56"
},
"address": {"address": "14 Wall Street, New York",
"address2": "75 Manhattan avenue",
"city": "New York",
"state": "New York State",
"zip": "000111",
"country": "USA"
},
"billingAddress": {"address": "14 Wall Street, New York",
"address2": "75 Manhattan avenue",
"city": "New York",
"state": "New York State",
"zip": "000111",
"country": "USA"
}
}

Response samples

200
400

Content type

application/json

{"expires_in": 300,
"token_type": "JWT",
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfaWQiOiJPazhCYzNmc0o0RGcwZGg2YkRIOWJkOHdnMWdjZXQiLCJjbGllbnRfaXAiOiI6OjEiLCJkZXZpY2UiOnsiX2lkIjoiNGU4ZTg0OTQtZWY5Zi00YmMxLTljNjUtMzFlZjFlMzcyZjA1IiwidHlwZSI6IlVOS05PV04iLCJwbGF0Zm9ybSI6IkJST1dTRVIiLCJzZXJpYWwiOiJEQTA5NEI5NTA2MDhEOEJBIiwibWFjIjoiODI6OTA6QTg6NTk6RDI6QjE6QzA6NzYifSwiZ3JhbnRfc2NvcGUiOiJjbGllbnQtYXBpIiwiZ3JhbnRfdHlwZSI6ImFjY2Vzc190b2tlbiIsImlhdCI6MTU0Mjc3OTkzNywiZXhwIjoxNTQyNzgwMjM3LCJhdWQiOiJ6YWFwdHYiLCJpc3MiOiJjbG91ZGFudGVubmUuY2giLCJzdWIiOiI1YmY0ZjQyMWY3MTZjZjJiZTk1NzE1MDkiLCJqdGkiOiJOWjJUSUNMWUpIMTRBSEtuIn0.iqVLPtqkpQTV9l93y6GGwN7KfNMc86smhg3Ol9MHt2g",
"refresh_token": "JWT:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfaWQiOiJPazhCYzNmc0o0RGcwZGg2YkRIOWJkOHdnMWdjZXQiLCJkZXZpY2UiOnsiX2lkIjoiNGU4ZTg0OTQtZWY5Zi00YmMxLTljNjUtMzFlZjFlMzcyZjA1IiwidHlwZSI6IlVOS05PV04iLCJwbGF0Zm9ybSI6IkJST1dTRVIiLCJzZXJpYWwiOiJEQTA5NEI5NTA2MDhEOEJBIiwibWFjIjoiODI6OTA6QTg6NTk6RDI6QjE6QzA6NzYifSwiZ3JhbnRfc2NvcGUiOiJjbGllbnQtYXBpIiwiZ3JhbnRfdHlwZSI6InJlZnJlc2hfdG9rZW4iLCJpYXQiOjE1NDI3Nzk5MzcsImV4cCI6MTU0MzM4NDczNywiYXVkIjoiemFhcHR2IiwiaXNzIjoiY2xvdWRhbnRlbm5lLmNoIiwic3ViIjoiNWJmNGY0MjFmNzE2Y2YyYmU5NTcxNTA5IiwianRpIjoiTloyVElDTFlKSDE0QUhLbiJ9.VUs5sxSd1c49lxA00tA4dPPMmIlrfLx9Qh38CY6qeY0",
"id_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfaWQiOiJPazhCYzNmc0o0RGcwZGg2YkRIOWJkOHdnMWdjZXQiLCJjbGllbnRfaXAiOiI6OjEiLCJkZXZpY2UiOnsiX2lkIjoiNGU4ZTg0OTQtZWY5Zi00YmMxLTljNjUtMzFlZjFlMzcyZjA1IiwidHlwZSI6IlVOS05PV04iLCJwbGF0Zm9ybSI6IkJST1dTRVIiLCJzZXJpYWwiOiJEQTA5NEI5NTA2MDhEOEJBIiwibWFjIjoiODI6OTA6QTg6NTk6RDI6QjE6QzA6NzYifSwiZ3JhbnRfc2NvcGUiOiJjbGllbnQtYXBpIiwiZ3JhbnRfdHlwZSI6ImFjY2Vzc190b2tlbiIsImlhdCI6MTU0Mjc3OTkzNywiZXhwIjoxNTQyNzgwMjM3LCJhdWQiOiJ6YWFwdHYiLCJpc3MiOiJjbG91ZGFudGVubmUuY2giLCJzdWIiOiI1YmY0ZjQyMWY3MTZjZjJiZTk1NzE1MDkiLCJqdGkiOiJOWjJUSUNMWUpIMTRBSEtuIn0.iqVLPtqkpQTV9l93y6GGwN7KfNMc86smhg3Ol9MHt2g"
}

Sign up activate

path Parameters

Token

required

string

Example: InOGX3kLDTVUZHLL5Ep5tiHIb9SA7XtO

Token

Responses

Response samples

200
403
404

Content type

application/json

{"status": "OK"
}

Re-send Activation Email

Request Body schema: application/json

email

required

string <email>

Responses

Request samples

Payload

Content type

application/json

{"email": "username@example.com"
}

Response samples

200
400

Content type

application/json

{"status": "OK"
}

Reset password

Request Body schema: application/json

email

required

string <email>

Responses

Request samples

Payload

Content type

application/json

{"email": "oliver.queen@mail.com"
}

Response samples

200
400

Content type

application/json

{"status": "OK"
}

Reset password activation

path Parameters

Token

required

string

Example: InOGX3kLDTVUZHLL5Ep5tiHIb9SA7XtO

Token

Request Body schema: application/json

password required	string >= 6
confirmPassword required	string >= 6

Responses

Request samples

Payload

Content type

application/json

{"password": "password",
"confirmPassword": "password"
}

Response samples

200
400
403

Content type

application/json

{"message": "Password has been successfully changed"
}

Customer

Authorizations:

JWT

Responses

Response samples

200

Content type

application/json

{"_id": "5915c3bacc8e1e13969de081",
"title": "",
"firstName": "Oliver",
"lastName": "Queen",
"middleName": "",
"prefix": "Mr",
"suffix": "Sr",
"activated": "2017-05-12T14:16:27.134Z",
"created": "2017-05-12T14:16:27.134Z",
"email": "oliver@queen.com",
"serviceProvider": "alphaott",
"location": {"ip": "216.162.47.73"
},
"billingAddress": {"address": "Tade Street",
"city": "New York",
"zip": "123 45",
"country": "USA"
},
"address": {"address": "Tade Street",
"city": "New York",
"zip": "123 45",
"country": "USA"
},
"phones": ["+21 123123123"
],
"services": [{"_id": "5915c3bacc8e1e13969de081",
"activated": "2017-05-12T14:16:27.134Z",
"created": "2017-05-12T14:16:27.134Z",
"expires": "2018-01-29T04:27:16.275Z",
"updated": "2017-12-29T04:27:16.275Z",
"serviceType": "LIVE_TV",
"status": "ACTIVE",
"contentType": "TV",
"scope": "ONE_ITEM",
"externalRefs": [{"type": "",
"ref": ""
}
],
"serviceSpec": "5915c39c1d6d2f134d69afb1"
}
]
}

Update Customer Profile

Authorizations:

JWT

Request Body schema: application/json

title	string
firstName	string
lastName	string
middleName	string
prefix	string
suffix	string
	object (address_Address)
	object (address_Address)

Responses

Request samples

Payload

Content type

application/json

{"title": "",
"firstName": "Oliver",
"lastName": "Queen",
"middleName": "",
"prefix": "Mr",
"suffix": "Sr",
"billingAddress": {"address": "Tade Street",
"city": "New York",
"zip": "123 45",
"country": "USA"
},
"address": {"address": "Tade Street",
"city": "New York",
"zip": "123 45",
"country": "USA"
}
}

Response samples

200
400

Content type

application/json

{"_id": "5915c3bacc8e1e13969de081",
"title": "",
"firstName": "Oliver",
"lastName": "Queen",
"middleName": "",
"prefix": "Mr",
"suffix": "Sr",
"activated": "2017-05-12T14:16:27.134Z",
"created": "2017-05-12T14:16:27.134Z",
"email": "oliver@queen.com",
"serviceProvider": "alphaott",
"location": {"ip": "216.162.47.73"
},
"billingAddress": {"address": "Tade Street",
"city": "New York",
"zip": "123 45",
"country": "USA"
},
"address": {"address": "Tade Street",
"city": "New York",
"zip": "123 45",
"country": "USA"
},
"phones": ["+21 123123123"
],
"services": [{"_id": "5915c3bacc8e1e13969de081",
"activated": "2017-05-12T14:16:27.134Z",
"created": "2017-05-12T14:16:27.134Z",
"expires": "2018-01-29T04:27:16.275Z",
"updated": "2017-12-29T04:27:16.275Z",
"serviceType": "LIVE_TV",
"status": "ACTIVE",
"contentType": "TV",
"scope": "ONE_ITEM",
"externalRefs": [{"type": "",
"ref": ""
}
],
"serviceSpec": "5915c39c1d6d2f134d69afb1"
}
]
}

Deactivate Customer

Authorizations:

JWT

Responses

Response samples

200
400

Content type

application/json

{"status": "OK"
}

Change Customer Password

Authorizations:

JWT

Request Body schema: application/json

oldPassword required	string
newPassword required	string
confirmPassword required	string

Responses

Request samples

Payload

Content type

application/json

{"oldPassword": "old_password",
"newPassword": "new_password",
"confirmPassword": "new_password"
}

Response samples

200
500

Content type

application/json

{"message": "Password has been successfully changed"
}

Get Personal List By List Type

Authorizations:

JWT

path Parameters

profileId required	string Example: 59e5b5c4a95efa0001e28e2d Profile ID
contentType required	string Example: MOVIE Content type
listType required	string Example: RECORDINGS List type

query Parameters

populate	number Example: populate=1 Populate
sort	string Default: "-ts" Example: sort=ts Sort
from	timestamp Example: from=1604679949 From

Responses

Response samples

200

Content type

application/json

[{"item": "5915c3dbfc819813c4c244cf",
"customer": "5915c3dbfc819813c4c244cf",
"type": "MOVIE",
"list": "RECORDINGS",
"ts": "2020-11-09T14:36:44.913Z",
"data": { }
}
]

Delete Personal List By List Type

Authorizations:

JWT

path Parameters

profileId required	string Example: 59e5b5c4a95efa0001e28e2d Profile ID
contentType required	string Example: MOVIE Content type
listType required	string Example: RECORDINGS List type

Responses

Response samples

200

Content type

application/json

{"status": "DELETED"
}

Get Personal List By Content Type

Authorizations:

JWT

path Parameters

profileId required	string Example: 59e5b5c4a95efa0001e28e2d Profile ID
contentType required	string Example: MOVIE Content type

query Parameters

populate	number Example: populate=1 Populate
sort	string Default: "-ts" Example: sort=ts Sort
populate	timestamp Example: populate=1604679949 from

Responses

Response samples

200

Content type

application/json

[{"item": "5915c3dbfc819813c4c244cf",
"customer": "5915c3dbfc819813c4c244cf",
"type": "MOVIE",
"list": "RECORDINGS",
"ts": "2020-11-09T14:36:44.913Z",
"data": { }
}
]

Get all personal lists for specific customer profile

Authorizations:

JWT

path Parameters

profileId

required

string

Example: 59e5b5c4a95efa0001e28e2d

Profile ID

Responses

Response samples

200

Content type

application/json

[{"item": "5915c3dbfc819813c4c244cf",
"customer": "5915c3dbfc819813c4c244cf",
"type": "MOVIE",
"list": "RECORDINGS",
"ts": "2020-11-09T14:36:44.913Z",
"data": { }
}
]

Delete Personal List By Profile

Authorizations:

JWT

path Parameters

profileId

required

string

Example: 59e5b5c4a95efa0001e28e2d

Profile ID

Responses

Response samples

200

Content type

application/json

{"status": "DELETED"
}

Delete Personal List By Content

Authorizations:

JWT

path Parameters

profileId required	string Example: 59e5b5c4a95efa0001e28e2d Profile ID
contentType required	string Example: MOVIE Content type
listType required	string Example: RECORDINGS List type
contentId required	string Example: 59e5b5c4a95efa0001e28e2d List type

Responses

Response samples

200

Content type

application/json

{"status": "DELETED"
}

Insert/Update Personal List

Authorizations:

JWT

path Parameters

profileId required	string Example: 59e5b5c4a95efa0001e28e2d Profile ID
contentType required	string Example: MOVIE Content type
listType required	string Example: RECORDINGS List type
contentId required	string Example: 59e5b5c4a95efa0001e28e2d List type

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{"item": "5915c3dbfc819813c4c244cf",
"customer": "5915c3dbfc819813c4c244cf",
"type": "MOVIE",
"list": "RECORDINGS",
"ts": "2020-11-09T14:36:44.913Z",
"data": { }
}

Get Customer Devices

Authorizations:

JWT

Responses

Response samples

200

Content type

application/json

[{"_id": "4e8e8494-ef9f-4bc1-9c65-31ef1e372f05",
"type": "UNKNOWN",
"model": "Gecko",
"platform": "BROWSER",
"brand": "Google Inc.",
"serial": "DA094B950608D8BA",
"mac": "82:90:A8:59:D2:B1:C0:76",
"created": "2017-05-12T14:16:27.134Z",
"status": "ACTIVE"
}
]

checkCustomerDeviceLimits

Authorizations:

JWT

query Parameters

contentId	string Example: contentId=5915c3e3201c2313ee14be2f Content ID
contentType	string Enum: "tv" "vod" "tvShow" "catchUp" Example: contentType=tv Content Type

Responses

Response samples

200
400
403

Content type

application/json

{"status": "OK"
}

Delete Customer Device

Authorizations:

JWT

path Parameters

deviceId

required

string

Example: 4e8e8494-ef9f-4bc1-9c65-31ef1e372f05

Device ID

Responses

Response samples

200
400

Content type

application/json

[{"_id": "4e8e8494-ef9f-4bc1-9c65-31ef1e372f05",
"type": "UNKNOWN",
"model": "Gecko",
"platform": "BROWSER",
"brand": "Google Inc.",
"serial": "DA094B950608D8BA",
"mac": "82:90:A8:59:D2:B1:C0:76",
"created": "2017-05-12T14:16:27.134Z",
"status": "ACTIVE"
}
]

Activate Voucher Code

Authorizations:

JWT

Request Body schema: application/json

code

required

string

Responses

Request samples

Payload

Content type

application/json

{"code": "38GG-61IW-UQU8-XYKX"
}

Response samples

200
400
500

Content type

application/json

{"_id": "38GG61IWUQU8XYKX",
"code": "38GG-61IW-UQU8-XYKX",
"type": "ACTIVATION",
"status": "ACTIVE",
"serviceProvider": "ZaapTV™",
"voucherGroup": "test voucher"
}

Channels

Returns a list of channels

Examples:

projection is default: /client/api/servicespec/59e5b2e2a95efa0001e26ee3/tv/channels
projection is brief: /client/api/servicespec/59e5b2e2a95efa0001e26ee3/tv/channels?brief

Responses

Request samples

JavaScript

import { getChannelsBrief } from 'api-client/channels'
const channels = await getChannelsBrief(serviceSpecId)

Response samples

200

Content type

application/json

[{"_id": "5915c3bacc8e1e13969de081",
"title": "Fox News",
"description": "Some description",
"number": 42,
"rating": 0.9258949160575867,
"hasEpg": true,
"offset": 420,
"logos": [{"path": "channel-logo/5918ab1ab7fb24263bf70b02.PNG"
}
],
"genres": ["5915c3ec201c2313ee14cb70"
],
"categories": ["5915c3941d6d2f134d699da3"
],
"countries": ["ARE"
],
"languages": ["ara"
],
"created": "2017-05-12T14:16:27.134Z",
"activated": "2017-05-12T14:16:27.134Z"
}
]

Channel Categories

Responses

Response samples

200

Content type

application/json

[{"_id": "592672a1b7fb245a4e417c0b",
"title": "Arabic Movies",
"description": "Some description",
"order": 1,
"rating": 0.694526195526123,
"posters": [{"_id": "592672a1b7fb245a4e417c0b",
"title": "Arabic Movies",
"path": "category-poster/5922f5aeb7fb245a4e400291.PNG",
"width": 160,
"height": 160
}
],
"backgrounds": [{"_id": "592672a1b7fb245a4e417c0b",
"title": "Arabic Movies",
"path": "category-poster/5922f5aeb7fb245a4e400291.PNG",
"width": 160,
"height": 160
}
]
}
]

Channel Countries

Examples:

Default: /client/api/servicespec/59e5b2e2a95efa0001e26ee3/tv/countries
Posters: /client/api/servicespec/59e5b2e2a95efa0001e26ee3/tv/countries?posters
Cards: /client/api/servicespec/59e5b2e2a95efa0001e26ee3/tv/countries?cards

Responses

Response samples

200

Content type

application/json

[{"_id": "GRC",
"commonName": "Greece"
}
]

Channel Genres

Responses

Response samples

200

Content type

application/json

[{"_id": "5915c3ec201c2313ee14cb70",
"title": "Arabic Comedy",
"description": "Some description",
"order": 1,
"rating": 0.9526172876358032,
"posters": [{"_id": "592672a1b7fb245a4e417c0b",
"title": "Arabic Movies",
"path": "category-poster/5922f5aeb7fb245a4e400291.PNG",
"width": 160,
"height": 160
}
],
"backgrounds": [{"_id": "592672a1b7fb245a4e417c0b",
"title": "Arabic Movies",
"path": "category-poster/5922f5aeb7fb245a4e400291.PNG",
"width": 160,
"height": 160
}
]
}
]

Channel Languages

Examples:

Default: /client/api/servicespec/59e5b2e2a95efa0001e26ee3/tv/languages
Posters: /client/api/servicespec/59e5b2e2a95efa0001e26ee3/tv/languages?posters
Cards: /client/api/servicespec/59e5b2e2a95efa0001e26ee3/tv/languages?cards

Responses

Response samples

200

Content type

application/json

[{"_id": "bul",
"name": "Bulgarian",
"order": 1,
"images": [{"_id": "5a4f232959cc7d08a23d76b2",
"title": "poster",
"path": "language-image/poster-ara.png"
}
]
}
]

Returns a channel/channels by ID or IDs

Responses

Response samples

200

Content type

application/json

[{"_id": "5915c3bacc8e1e13969de081",
"title": "Fox News",
"description": "Some description",
"number": 42,
"rating": 0.9258949160575867,
"hasEpg": true,
"offset": 420,
"logos": [{"path": "channel-logo/5918ab1ab7fb24263bf70b02.PNG"
}
],
"genres": ["5915c3ec201c2313ee14cb70"
],
"categories": ["5915c3941d6d2f134d699da3"
],
"countries": ["ARE"
],
"languages": ["ara"
],
"created": "2017-05-12T14:16:27.134Z",
"activated": "2017-05-12T14:16:27.134Z"
}
]

Channel Source Deprecated

Authorizations:

JWT

Request Body schema: application/json

id

required

string >= 1

Channel ID or list of ids 5915c3e3201c2313ee14be2f,592672a1b7fb245a4e417c0b

Responses

Request samples

Payload

Content type

application/json

{"id": "5915c3e3201c2313ee14be2f"
}

Response samples

200

Content type

application/json

[{"5915c3e3201c2313ee14be2f": ["http://lv003.cdn.alphaott.com/live/m3u8/H7sKl3Sdxmbc3.m3u8"
]
}
]

Channel Ad Source Deprecated

Authorizations:

JWT

Request Body schema: application/json

id

required

string >= 1

Channel ID or list of ids 5915c3e3201c2313ee14be2f,592672a1b7fb245a4e417c0b

Responses

Request samples

Payload

Content type

application/json

{"id": "5915c3e3201c2313ee14be2f"
}

Response samples

200

Content type

application/json

{"5915c3e3201c2313ee14be2f": {"screenRatio": 1.3333333730697632,
"volume": 100,
"mediaUrls": ["http://lv004.cdn.lbcdn.com/live/m3u8/jordannoor.m3u8?hdnts=exp=1548785249128~acl=/live/m3u8/jordannoor.m3u8*~hmac=84dadfde07b080e1b2d22acf618c2a6223f281d6ad4dd68bc22da8db14993453"
],
"ads": {"vastUrl": "http://v.lkqd.net/ad?pid=9&sid=977875&output=vastvpaid&support=html5&execution=any&placement=&playinit=auto&volume=100&&contentid=5915c3cdfc819813c4c22bfd&contenttitle=jordannoor",
"provider": "adsense",
"options": { }
}
}
}

Channel Source V3

Authorizations:

JWT

Request Body schema: application/json

id

required

string >= 1

Channel ID or list of ids 5915c3e3201c2313ee14be2f,592672a1b7fb245a4e417c0b

Responses

Request samples

Payload

Content type

application/json

{"id": "5915c3e3201c2313ee14be2f"
}

Response samples

200
451

Content type

application/json

{"5915c3e3201c2313ee14be2f": [{"screenRatio": 1.3333333730697632,
"volume": 100,
"type": "MPEG_DASH",
"sources": [{"src": "http://lv002.cdn.lbcdn.com/live/m3u8/Alforat.m3u8?hdnts=exp=1556720253069~acl=/live/m3u8/Alforat.m3u8*~hmac=85c51ae57c59b5182f950d131d21ce4217b6415d2e1bc108b06d18320add2a9a",
"priority": 10,
"protocol": "HTTP",
"ttl": 3600
}
],
"ads": {"vastUrl": "http://v.lkqd.net/ad?pid=9&sid=977875&output=vastvpaid&support=html5&execution=any&placement=&playinit=auto&volume=100&&contentid=5915c3cdfc819813c4c22bfd&contenttitle=jordannoor",
"provider": "adsense",
"options": { }
},
"drm": {"types": ["WIDEVINE",
"PLAYREADY"
],
"ttl": 43200,
"WIDEVINE": {"licenseUri": "https://wv-keyos.licensekeyserver.com/",
"licenseHeaders": {"customdata": "PEtleU9TQXV0aGVudGljYXRpb25YTUw+IDxEYXRhPiAgIDxHZW5lcmF0aW9uVGltZT4yMDE5LTA1LTAxIDE0OjEyOjMzLjA3MDwvR2VuZXJhdGlvblRpbWU+ICAgPEV4cGlyYXRpb25UaW1lPjIwMTktMDUtMzEgMTQ6MTI6MzMuMDcwPC9FeHBpcmF0aW9uVGltZT4gICA8VW5pcXVlSWQ+ZTIwYTk0MDMtZWU2Yy00MzdiLWIwZjAtYmM4NjFhOGJjZGUwPC9VbmlxdWVJZD4gICA8UlNBUHViS2V5SWQ+NWMxNzI3MjM4OWVkNzMyMTFiNjczNDA0Zjk4NmFkMjQ8L1JTQVB1YktleUlkPiAgIDxXaWRldmluZVBvbGljeSBmbF9DYW5QbGF5PSJ0cnVlIiBmbF9DYW5QZXJzaXN0PSJmYWxzZSIgLz4gICA8V2lkZXZpbmVDb250ZW50S2V5U3BlYyBUcmFja1R5cGU9IkhEIj4gICAgIDxTZWN1cml0eUxldmVsPjE8L1NlY3VyaXR5TGV2ZWw+ICAgPC9XaWRldmluZUNvbnRlbnRLZXlTcGVjPiAgIDxGYWlyUGxheVBvbGljeSBwZXJzaXN0ZW50PSJmYWxzZSIgLz4gICA8TGljZW5zZSB0eXBlPSJzaW1wbGUiIC8+IDwvRGF0YT4gPFNpZ25hdHVyZT5hdXkxaUlkM0NRUnFuWm9tRUgxZGRIcHJnNEZhTFJJdGFFM1paS01BcjlzdmZYbVpzODhBdlFrZVdjN0MxOXZnZkNiTmNlMDNVREZTWDNLZXRIb2RXb3J6TWd0VExQdVVUdVhRNUkxRERXLzQzbDdmK3RJdnJOYjAzUkNTRVJPQytNa0U3YXhpaW5RVkRqejNsZ1k5ajRMK3ZJSjZBWmVva3NsazZ2V0ZDME9VcVQ1Nk5uMHZsT0xmNThuUDNWdGFpY2x0TlptZ2h4NjJPRmRsNEdiQktvWUNvZVhGOFE4NG04WThicEZCd1R0QlM3Y01ra1JzTUJ5MDVsWjUwN1NBcTliMEVLYm5ReHNjZHlWcVJRZW9hTit3aTJJSGY4V0k1dTQxSzdPZktkNW9nNEUxT2lBKzhLZ3g0WXBFZTh1TEJwQVp1aE5LVDFzRE5zOFFRSm9FZkEmI3gzRDsmI3gzRDs8L1NpZ25hdHVyZT4gPC9LZXlPU0F1dGhlbnRpY2F0aW9uWE1MPg&#x3D;&#x3D;"
}
},
"PLAYREADY": {"licenseUri": "https://pr-keyos.licensekeyserver.com/core/rightsmanager.asmx",
"licenseHeaders": {"customdata": "PEtleU9TQXV0aGVudGljYXRpb25YTUw+IDxEYXRhPiAgIDxHZW5lcmF0aW9uVGltZT4yMDE5LTA1LTAxIDE0OjEyOjMzLjA3MDwvR2VuZXJhdGlvblRpbWU+ICAgPEV4cGlyYXRpb25UaW1lPjIwMTktMDUtMzEgMTQ6MTI6MzMuMDcwPC9FeHBpcmF0aW9uVGltZT4gICA8VW5pcXVlSWQ+ZTIwYTk0MDMtZWU2Yy00MzdiLWIwZjAtYmM4NjFhOGJjZGUwPC9VbmlxdWVJZD4gICA8UlNBUHViS2V5SWQ+NWMxNzI3MjM4OWVkNzMyMTFiNjczNDA0Zjk4NmFkMjQ8L1JTQVB1YktleUlkPiAgIDxXaWRldmluZVBvbGljeSBmbF9DYW5QbGF5PSJ0cnVlIiBmbF9DYW5QZXJzaXN0PSJmYWxzZSIgLz4gICA8V2lkZXZpbmVDb250ZW50S2V5U3BlYyBUcmFja1R5cGU9IkhEIj4gICAgIDxTZWN1cml0eUxldmVsPjE8L1NlY3VyaXR5TGV2ZWw+ICAgPC9XaWRldmluZUNvbnRlbnRLZXlTcGVjPiAgIDxGYWlyUGxheVBvbGljeSBwZXJzaXN0ZW50PSJmYWxzZSIgLz4gICA8TGljZW5zZSB0eXBlPSJzaW1wbGUiIC8+IDwvRGF0YT4gPFNpZ25hdHVyZT5hdXkxaUlkM0NRUnFuWm9tRUgxZGRIcHJnNEZhTFJJdGFFM1paS01BcjlzdmZYbVpzODhBdlFrZVdjN0MxOXZnZkNiTmNlMDNVREZTWDNLZXRIb2RXb3J6TWd0VExQdVVUdVhRNUkxRERXLzQzbDdmK3RJdnJOYjAzUkNTRVJPQytNa0U3YXhpaW5RVkRqejNsZ1k5ajRMK3ZJSjZBWmVva3NsazZ2V0ZDME9VcVQ1Nk5uMHZsT0xmNThuUDNWdGFpY2x0TlptZ2h4NjJPRmRsNEdiQktvWUNvZVhGOFE4NG04WThicEZCd1R0QlM3Y01ra1JzTUJ5MDVsWjUwN1NBcTliMEVLYm5ReHNjZHlWcVJRZW9hTit3aTJJSGY4V0k1dTQxSzdPZktkNW9nNEUxT2lBKzhLZ3g0WXBFZTh1TEJwQVp1aE5LVDFzRE5zOFFRSm9FZkEmI3gzRDsmI3gzRDs8L1NpZ25hdHVyZT4gPC9LZXlPU0F1dGhlbnRpY2F0aW9uWE1MPg&#x3D;&#x3D;"
}
},
"FAIRPLAY": {"licenseUri": "https://fp-keyos.licensekeyserver.com/getkey",
"licenseHeaders": {"customdata": "PEtleU9TQXV0aGVudGljYXRpb25YTUw+IDxEYXRhPiAgIDxHZW5lcmF0aW9uVGltZT4yMDE5LTA1LTAxIDE0OjEyOjMzLjA3MDwvR2VuZXJhdGlvblRpbWU+ICAgPEV4cGlyYXRpb25UaW1lPjIwMTktMDUtMzEgMTQ6MTI6MzMuMDcwPC9FeHBpcmF0aW9uVGltZT4gICA8VW5pcXVlSWQ+ZTIwYTk0MDMtZWU2Yy00MzdiLWIwZjAtYmM4NjFhOGJjZGUwPC9VbmlxdWVJZD4gICA8UlNBUHViS2V5SWQ+NWMxNzI3MjM4OWVkNzMyMTFiNjczNDA0Zjk4NmFkMjQ8L1JTQVB1YktleUlkPiAgIDxXaWRldmluZVBvbGljeSBmbF9DYW5QbGF5PSJ0cnVlIiBmbF9DYW5QZXJzaXN0PSJmYWxzZSIgLz4gICA8V2lkZXZpbmVDb250ZW50S2V5U3BlYyBUcmFja1R5cGU9IkhEIj4gICAgIDxTZWN1cml0eUxldmVsPjE8L1NlY3VyaXR5TGV2ZWw+ICAgPC9XaWRldmluZUNvbnRlbnRLZXlTcGVjPiAgIDxGYWlyUGxheVBvbGljeSBwZXJzaXN0ZW50PSJmYWxzZSIgLz4gICA8TGljZW5zZSB0eXBlPSJzaW1wbGUiIC8+IDwvRGF0YT4gPFNpZ25hdHVyZT5hdXkxaUlkM0NRUnFuWm9tRUgxZGRIcHJnNEZhTFJJdGFFM1paS01BcjlzdmZYbVpzODhBdlFrZVdjN0MxOXZnZkNiTmNlMDNVREZTWDNLZXRIb2RXb3J6TWd0VExQdVVUdVhRNUkxRERXLzQzbDdmK3RJdnJOYjAzUkNTRVJPQytNa0U3YXhpaW5RVkRqejNsZ1k5ajRMK3ZJSjZBWmVva3NsazZ2V0ZDME9VcVQ1Nk5uMHZsT0xmNThuUDNWdGFpY2x0TlptZ2h4NjJPRmRsNEdiQktvWUNvZVhGOFE4NG04WThicEZCd1R0QlM3Y01ra1JzTUJ5MDVsWjUwN1NBcTliMEVLYm5ReHNjZHlWcVJRZW9hTit3aTJJSGY4V0k1dTQxSzdPZktkNW9nNEUxT2lBKzhLZ3g0WXBFZTh1TEJwQVp1aE5LVDFzRE5zOFFRSm9FZkEmI3gzRDsmI3gzRDs8L1NpZ25hdHVyZT4gPC9LZXlPU0F1dGhlbnRpY2F0aW9uWE1MPg&#x3D;&#x3D;"
},
"certificateUri": "https://fp-keyos.licensekeyserver.com/cert/5c17272389ed73211b673404f986ad24.der",
"certificateHeaders": {"customeheader": "customdata"
}
}
}
}
]
}

TV program list

Examples:

get a Program list for 2019-02-20: /client/api/tv/channel/5915c3b1cc8e1e13969dcfa9/programs?date=2019-02-20
get a Program list from 2019-02-20 to 2019-02-22 inclusively: /client/api/tv/channel/5915c3b1cc8e1e13969dcfa9/programs?start=2019-02-20&end=2019-02-22
get a Program list for 2019-02-20 with timezone=360 & includeStop=true: /client/api/tv/channel/5915c3b1cc8e1e13969dcfa9/programs?date=2019-02-20&timezoneOffset=360&includeStop

Responses

Response samples

200

Content type

application/json

[{"id": "id",
"title": "some title",
"description": "some description",
"credits": "some credits",
"episode": "some episode",
"start": "2017-05-12T14:16:27.134Z",
"stop": "2017-05-12T16:16:27.134Z"
}
]

TV program list V2

Examples:

get a Program list for 2019-02-20: /client/api/v2/tv/channel/5915c3b1cc8e1e13969dcfa9/programs?date=2019-02-20
get a Program list from 2019-02-20 to 2019-02-22 inclusively: /client/api/v2/tv/channel/5915c3b1cc8e1e13969dcfa9/programs?start=2019-02-20&end=2019-02-22
get a Program list for 2019-02-20 with timezone=360 & includeStop=true: /client/api/v2/tv/channel/5915c3b1cc8e1e13969dcfa9/programs?date=2019-02-20&timezoneOffset=360&includeStop

Responses

Response samples

200

Content type

application/json

[{"id": "id",
"title": "some title",
"subtitle": "some subtitle",
"description": "some description",
"credits": [{"name": "name of credit",
"role": "role of credit"
}
],
"categories": ["Drama"
],
"episode": "some episode",
"start": "2017-05-12T14:16:27.134Z",
"stop": "2017-05-12T16:16:27.134Z"
}
]

TV program

Responses

Response samples

200

Content type

application/json

{"id": "id",
"title": "some title",
"description": "some description",
"credits": "some credits",
"episode": "some episode",
"start": "2017-05-12T14:16:27.134Z",
"stop": "2017-05-12T16:16:27.134Z"
}

TV program V2

Responses

Response samples

200

Content type

application/json

{"id": "id",
"title": "some title",
"subtitle": "some subtitle",
"description": "some description",
"credits": [{"name": "name of credit",
"role": "role of credit"
}
],
"categories": ["Drama"
],
"episode": "some episode",
"start": "2017-05-12T14:16:27.134Z",
"stop": "2017-05-12T16:16:27.134Z"
}

TV channels with program list

Examples:

get a Program list for 2019-02-20: /client/api/servicespec/5915c39b1d6d2f134d69af51/tv/programs?date=2019-02-20
get a Program list from 2019-02-20 to 2019-02-22 inclusively: /client/api/servicespec/5915c39b1d6d2f134d69af51/tv/programs?start=2019-02-20&end=2019-02-22
get a Program list for 2019-02-20 with timezone=360 & includeStop=true: /client/api/servicespec/5915c39b1d6d2f134d69af51/tv/programs?date=2019-02-20&timezoneOffset=360&includeStop

Responses

Response samples

200

Content type

application/json

{"5915c3e3201c2313ee14be2f": [{"id": "program id",
"title": "program title",
"description": "program description",
"credits": "program credits",
"episode": "program episode",
"start": "2017-05-12T14:16:27.134Z",
"stop": "2017-05-12T16:16:27.134Z"
}
]
}

TV channels with program list V2

Examples:

get a Program list for 2019-02-20: /client/api/v2/servicespec/5915c39b1d6d2f134d69af51/tv/programs?date=2019-02-20
get a Program list from 2019-02-20 to 2019-02-22 inclusively: /client/api/v2/servicespec/5915c39b1d6d2f134d69af51/tv/programs?start=2019-02-20&end=2019-02-22
get a Program list for 2019-02-20 with timezone=360 & includeStop=true: /client/api/v2/servicespec/5915c39b1d6d2f134d69af51/tv/programs?date=2019-02-20&timezoneOffset=360&includeStop

Responses

Response samples

200

Content type

application/json

{"5915c3e3201c2313ee14be2f": [{"id": "program id",
"title": "program title",
"description": "program description",
"credits": ["program credits"
],
"episode": "program episode",
"categories": ["some categories"
],
"start": "2017-05-12T14:16:27.134Z",
"stop": "2017-05-12T16:16:27.134Z"
}
]
}

CatchUp

CatchUp Channels

Responses

Response samples

200

Content type

application/json

{"5915c3e3201c2313ee14be2f": {"window": 86400
},
"5915c3bacc8e1e13969de081": {"window": 86400
},
"5915c3a7cc8e1e13969dc308": {"window": 86400
},
"5915c37c1d6d2f134d697eda": {"window": 86400
},
"5915c3a0cc8e1e13969db991": {"window": 86400
},
"5915c3cafc819813c4c2285b": {"window": 86400
},
"5915c3a7cc8e1e13969dc309": {"window": 86400
}
}

CatchUp Channel Source

Authorizations:

JWT

Responses

Response samples

200
451

Content type

application/json

[{"screenRatio": 1.3333333730697632,
"volume": 100,
"type": "MPEG_DASH",
"sources": [{"src": "http://lv002.cdn.lbcdn.com/live/m3u8/Alforat.m3u8?hdnts=exp=1556720253069~acl=/live/m3u8/Alforat.m3u8*~hmac=85c51ae57c59b5182f950d131d21ce4217b6415d2e1bc108b06d18320add2a9a",
"priority": 10,
"protocol": "HTTP",
"ttl": 3600
}
],
"ads": {"vastUrl": "http://v.lkqd.net/ad?pid=9&sid=977875&output=vastvpaid&support=html5&execution=any&placement=&playinit=auto&volume=100&&contentid=5915c3cdfc819813c4c22bfd&contenttitle=jordannoor",
"provider": "adsense",
"options": { }
},
"drm": {"types": ["WIDEVINE",
"PLAYREADY"
],
"ttl": 43200,
"WIDEVINE": {"licenseUri": "https://wv-keyos.licensekeyserver.com/",
"licenseHeaders": {"customdata": "PEtleU9TQXV0aGVudGljYXRpb25YTUw+IDxEYXRhPiAgIDxHZW5lcmF0aW9uVGltZT4yMDE5LTA1LTAxIDE0OjEyOjMzLjA3MDwvR2VuZXJhdGlvblRpbWU+ICAgPEV4cGlyYXRpb25UaW1lPjIwMTktMDUtMzEgMTQ6MTI6MzMuMDcwPC9FeHBpcmF0aW9uVGltZT4gICA8VW5pcXVlSWQ+ZTIwYTk0MDMtZWU2Yy00MzdiLWIwZjAtYmM4NjFhOGJjZGUwPC9VbmlxdWVJZD4gICA8UlNBUHViS2V5SWQ+NWMxNzI3MjM4OWVkNzMyMTFiNjczNDA0Zjk4NmFkMjQ8L1JTQVB1YktleUlkPiAgIDxXaWRldmluZVBvbGljeSBmbF9DYW5QbGF5PSJ0cnVlIiBmbF9DYW5QZXJzaXN0PSJmYWxzZSIgLz4gICA8V2lkZXZpbmVDb250ZW50S2V5U3BlYyBUcmFja1R5cGU9IkhEIj4gICAgIDxTZWN1cml0eUxldmVsPjE8L1NlY3VyaXR5TGV2ZWw+ICAgPC9XaWRldmluZUNvbnRlbnRLZXlTcGVjPiAgIDxGYWlyUGxheVBvbGljeSBwZXJzaXN0ZW50PSJmYWxzZSIgLz4gICA8TGljZW5zZSB0eXBlPSJzaW1wbGUiIC8+IDwvRGF0YT4gPFNpZ25hdHVyZT5hdXkxaUlkM0NRUnFuWm9tRUgxZGRIcHJnNEZhTFJJdGFFM1paS01BcjlzdmZYbVpzODhBdlFrZVdjN0MxOXZnZkNiTmNlMDNVREZTWDNLZXRIb2RXb3J6TWd0VExQdVVUdVhRNUkxRERXLzQzbDdmK3RJdnJOYjAzUkNTRVJPQytNa0U3YXhpaW5RVkRqejNsZ1k5ajRMK3ZJSjZBWmVva3NsazZ2V0ZDME9VcVQ1Nk5uMHZsT0xmNThuUDNWdGFpY2x0TlptZ2h4NjJPRmRsNEdiQktvWUNvZVhGOFE4NG04WThicEZCd1R0QlM3Y01ra1JzTUJ5MDVsWjUwN1NBcTliMEVLYm5ReHNjZHlWcVJRZW9hTit3aTJJSGY4V0k1dTQxSzdPZktkNW9nNEUxT2lBKzhLZ3g0WXBFZTh1TEJwQVp1aE5LVDFzRE5zOFFRSm9FZkEmI3gzRDsmI3gzRDs8L1NpZ25hdHVyZT4gPC9LZXlPU0F1dGhlbnRpY2F0aW9uWE1MPg&#x3D;&#x3D;"
}
},
"PLAYREADY": {"licenseUri": "https://pr-keyos.licensekeyserver.com/core/rightsmanager.asmx",
"licenseHeaders": {"customdata": "PEtleU9TQXV0aGVudGljYXRpb25YTUw+IDxEYXRhPiAgIDxHZW5lcmF0aW9uVGltZT4yMDE5LTA1LTAxIDE0OjEyOjMzLjA3MDwvR2VuZXJhdGlvblRpbWU+ICAgPEV4cGlyYXRpb25UaW1lPjIwMTktMDUtMzEgMTQ6MTI6MzMuMDcwPC9FeHBpcmF0aW9uVGltZT4gICA8VW5pcXVlSWQ+ZTIwYTk0MDMtZWU2Yy00MzdiLWIwZjAtYmM4NjFhOGJjZGUwPC9VbmlxdWVJZD4gICA8UlNBUHViS2V5SWQ+NWMxNzI3MjM4OWVkNzMyMTFiNjczNDA0Zjk4NmFkMjQ8L1JTQVB1YktleUlkPiAgIDxXaWRldmluZVBvbGljeSBmbF9DYW5QbGF5PSJ0cnVlIiBmbF9DYW5QZXJzaXN0PSJmYWxzZSIgLz4gICA8V2lkZXZpbmVDb250ZW50S2V5U3BlYyBUcmFja1R5cGU9IkhEIj4gICAgIDxTZWN1cml0eUxldmVsPjE8L1NlY3VyaXR5TGV2ZWw+ICAgPC9XaWRldmluZUNvbnRlbnRLZXlTcGVjPiAgIDxGYWlyUGxheVBvbGljeSBwZXJzaXN0ZW50PSJmYWxzZSIgLz4gICA8TGljZW5zZSB0eXBlPSJzaW1wbGUiIC8+IDwvRGF0YT4gPFNpZ25hdHVyZT5hdXkxaUlkM0NRUnFuWm9tRUgxZGRIcHJnNEZhTFJJdGFFM1paS01BcjlzdmZYbVpzODhBdlFrZVdjN0MxOXZnZkNiTmNlMDNVREZTWDNLZXRIb2RXb3J6TWd0VExQdVVUdVhRNUkxRERXLzQzbDdmK3RJdnJOYjAzUkNTRVJPQytNa0U3YXhpaW5RVkRqejNsZ1k5ajRMK3ZJSjZBWmVva3NsazZ2V0ZDME9VcVQ1Nk5uMHZsT0xmNThuUDNWdGFpY2x0TlptZ2h4NjJPRmRsNEdiQktvWUNvZVhGOFE4NG04WThicEZCd1R0QlM3Y01ra1JzTUJ5MDVsWjUwN1NBcTliMEVLYm5ReHNjZHlWcVJRZW9hTit3aTJJSGY4V0k1dTQxSzdPZktkNW9nNEUxT2lBKzhLZ3g0WXBFZTh1TEJwQVp1aE5LVDFzRE5zOFFRSm9FZkEmI3gzRDsmI3gzRDs8L1NpZ25hdHVyZT4gPC9LZXlPU0F1dGhlbnRpY2F0aW9uWE1MPg&#x3D;&#x3D;"
}
},
"FAIRPLAY": {"licenseUri": "https://fp-keyos.licensekeyserver.com/getkey",
"licenseHeaders": {"customdata": "PEtleU9TQXV0aGVudGljYXRpb25YTUw+IDxEYXRhPiAgIDxHZW5lcmF0aW9uVGltZT4yMDE5LTA1LTAxIDE0OjEyOjMzLjA3MDwvR2VuZXJhdGlvblRpbWU+ICAgPEV4cGlyYXRpb25UaW1lPjIwMTktMDUtMzEgMTQ6MTI6MzMuMDcwPC9FeHBpcmF0aW9uVGltZT4gICA8VW5pcXVlSWQ+ZTIwYTk0MDMtZWU2Yy00MzdiLWIwZjAtYmM4NjFhOGJjZGUwPC9VbmlxdWVJZD4gICA8UlNBUHViS2V5SWQ+NWMxNzI3MjM4OWVkNzMyMTFiNjczNDA0Zjk4NmFkMjQ8L1JTQVB1YktleUlkPiAgIDxXaWRldmluZVBvbGljeSBmbF9DYW5QbGF5PSJ0cnVlIiBmbF9DYW5QZXJzaXN0PSJmYWxzZSIgLz4gICA8V2lkZXZpbmVDb250ZW50S2V5U3BlYyBUcmFja1R5cGU9IkhEIj4gICAgIDxTZWN1cml0eUxldmVsPjE8L1NlY3VyaXR5TGV2ZWw+ICAgPC9XaWRldmluZUNvbnRlbnRLZXlTcGVjPiAgIDxGYWlyUGxheVBvbGljeSBwZXJzaXN0ZW50PSJmYWxzZSIgLz4gICA8TGljZW5zZSB0eXBlPSJzaW1wbGUiIC8+IDwvRGF0YT4gPFNpZ25hdHVyZT5hdXkxaUlkM0NRUnFuWm9tRUgxZGRIcHJnNEZhTFJJdGFFM1paS01BcjlzdmZYbVpzODhBdlFrZVdjN0MxOXZnZkNiTmNlMDNVREZTWDNLZXRIb2RXb3J6TWd0VExQdVVUdVhRNUkxRERXLzQzbDdmK3RJdnJOYjAzUkNTRVJPQytNa0U3YXhpaW5RVkRqejNsZ1k5ajRMK3ZJSjZBWmVva3NsazZ2V0ZDME9VcVQ1Nk5uMHZsT0xmNThuUDNWdGFpY2x0TlptZ2h4NjJPRmRsNEdiQktvWUNvZVhGOFE4NG04WThicEZCd1R0QlM3Y01ra1JzTUJ5MDVsWjUwN1NBcTliMEVLYm5ReHNjZHlWcVJRZW9hTit3aTJJSGY4V0k1dTQxSzdPZktkNW9nNEUxT2lBKzhLZ3g0WXBFZTh1TEJwQVp1aE5LVDFzRE5zOFFRSm9FZkEmI3gzRDsmI3gzRDs8L1NpZ25hdHVyZT4gPC9LZXlPU0F1dGhlbnRpY2F0aW9uWE1MPg&#x3D;&#x3D;"
},
"certificateUri": "https://fp-keyos.licensekeyserver.com/cert/5c17272389ed73211b673404f986ad24.der",
"certificateHeaders": {"customeheader": "customdata"
}
}
}
}
]

NPVR

NPVR Channels

Responses

Response samples

200

Content type

application/json

{"5915c3e3201c2313ee14be2f": {"window": 86400
},
"5915c3bacc8e1e13969de081": {"window": 86400
},
"5915c3a7cc8e1e13969dc308": {"window": 86400
},
"5915c37c1d6d2f134d697eda": {"window": 86400
},
"5915c3a0cc8e1e13969db991": {"window": 86400
},
"5915c3cafc819813c4c2285b": {"window": 86400
},
"5915c3a7cc8e1e13969dc309": {"window": 86400
}
}

NPVR Channel Source

Authorizations:

JWT

Responses

Response samples

200
451

Content type

application/json

[{"screenRatio": 1.3333333730697632,
"volume": 100,
"type": "MPEG_DASH",
"sources": [{"src": "http://lv002.cdn.lbcdn.com/live/m3u8/Alforat.m3u8?hdnts=exp=1556720253069~acl=/live/m3u8/Alforat.m3u8*~hmac=85c51ae57c59b5182f950d131d21ce4217b6415d2e1bc108b06d18320add2a9a",
"priority": 10,
"protocol": "HTTP",
"ttl": 3600
}
],
"ads": {"vastUrl": "http://v.lkqd.net/ad?pid=9&sid=977875&output=vastvpaid&support=html5&execution=any&placement=&playinit=auto&volume=100&&contentid=5915c3cdfc819813c4c22bfd&contenttitle=jordannoor",
"provider": "adsense",
"options": { }
},
"drm": {"types": ["WIDEVINE",
"PLAYREADY"
],
"ttl": 43200,
"WIDEVINE": {"licenseUri": "https://wv-keyos.licensekeyserver.com/",
"licenseHeaders": {"customdata": "PEtleU9TQXV0aGVudGljYXRpb25YTUw+IDxEYXRhPiAgIDxHZW5lcmF0aW9uVGltZT4yMDE5LTA1LTAxIDE0OjEyOjMzLjA3MDwvR2VuZXJhdGlvblRpbWU+ICAgPEV4cGlyYXRpb25UaW1lPjIwMTktMDUtMzEgMTQ6MTI6MzMuMDcwPC9FeHBpcmF0aW9uVGltZT4gICA8VW5pcXVlSWQ+ZTIwYTk0MDMtZWU2Yy00MzdiLWIwZjAtYmM4NjFhOGJjZGUwPC9VbmlxdWVJZD4gICA8UlNBUHViS2V5SWQ+NWMxNzI3MjM4OWVkNzMyMTFiNjczNDA0Zjk4NmFkMjQ8L1JTQVB1YktleUlkPiAgIDxXaWRldmluZVBvbGljeSBmbF9DYW5QbGF5PSJ0cnVlIiBmbF9DYW5QZXJzaXN0PSJmYWxzZSIgLz4gICA8V2lkZXZpbmVDb250ZW50S2V5U3BlYyBUcmFja1R5cGU9IkhEIj4gICAgIDxTZWN1cml0eUxldmVsPjE8L1NlY3VyaXR5TGV2ZWw+ICAgPC9XaWRldmluZUNvbnRlbnRLZXlTcGVjPiAgIDxGYWlyUGxheVBvbGljeSBwZXJzaXN0ZW50PSJmYWxzZSIgLz4gICA8TGljZW5zZSB0eXBlPSJzaW1wbGUiIC8+IDwvRGF0YT4gPFNpZ25hdHVyZT5hdXkxaUlkM0NRUnFuWm9tRUgxZGRIcHJnNEZhTFJJdGFFM1paS01BcjlzdmZYbVpzODhBdlFrZVdjN0MxOXZnZkNiTmNlMDNVREZTWDNLZXRIb2RXb3J6TWd0VExQdVVUdVhRNUkxRERXLzQzbDdmK3RJdnJOYjAzUkNTRVJPQytNa0U3YXhpaW5RVkRqejNsZ1k5ajRMK3ZJSjZBWmVva3NsazZ2V0ZDME9VcVQ1Nk5uMHZsT0xmNThuUDNWdGFpY2x0TlptZ2h4NjJPRmRsNEdiQktvWUNvZVhGOFE4NG04WThicEZCd1R0QlM3Y01ra1JzTUJ5MDVsWjUwN1NBcTliMEVLYm5ReHNjZHlWcVJRZW9hTit3aTJJSGY4V0k1dTQxSzdPZktkNW9nNEUxT2lBKzhLZ3g0WXBFZTh1TEJwQVp1aE5LVDFzRE5zOFFRSm9FZkEmI3gzRDsmI3gzRDs8L1NpZ25hdHVyZT4gPC9LZXlPU0F1dGhlbnRpY2F0aW9uWE1MPg&#x3D;&#x3D;"
}
},
"PLAYREADY": {"licenseUri": "https://pr-keyos.licensekeyserver.com/core/rightsmanager.asmx",
"licenseHeaders": {"customdata": "PEtleU9TQXV0aGVudGljYXRpb25YTUw+IDxEYXRhPiAgIDxHZW5lcmF0aW9uVGltZT4yMDE5LTA1LTAxIDE0OjEyOjMzLjA3MDwvR2VuZXJhdGlvblRpbWU+ICAgPEV4cGlyYXRpb25UaW1lPjIwMTktMDUtMzEgMTQ6MTI6MzMuMDcwPC9FeHBpcmF0aW9uVGltZT4gICA8VW5pcXVlSWQ+ZTIwYTk0MDMtZWU2Yy00MzdiLWIwZjAtYmM4NjFhOGJjZGUwPC9VbmlxdWVJZD4gICA8UlNBUHViS2V5SWQ+NWMxNzI3MjM4OWVkNzMyMTFiNjczNDA0Zjk4NmFkMjQ8L1JTQVB1YktleUlkPiAgIDxXaWRldmluZVBvbGljeSBmbF9DYW5QbGF5PSJ0cnVlIiBmbF9DYW5QZXJzaXN0PSJmYWxzZSIgLz4gICA8V2lkZXZpbmVDb250ZW50S2V5U3BlYyBUcmFja1R5cGU9IkhEIj4gICAgIDxTZWN1cml0eUxldmVsPjE8L1NlY3VyaXR5TGV2ZWw+ICAgPC9XaWRldmluZUNvbnRlbnRLZXlTcGVjPiAgIDxGYWlyUGxheVBvbGljeSBwZXJzaXN0ZW50PSJmYWxzZSIgLz4gICA8TGljZW5zZSB0eXBlPSJzaW1wbGUiIC8+IDwvRGF0YT4gPFNpZ25hdHVyZT5hdXkxaUlkM0NRUnFuWm9tRUgxZGRIcHJnNEZhTFJJdGFFM1paS01BcjlzdmZYbVpzODhBdlFrZVdjN0MxOXZnZkNiTmNlMDNVREZTWDNLZXRIb2RXb3J6TWd0VExQdVVUdVhRNUkxRERXLzQzbDdmK3RJdnJOYjAzUkNTRVJPQytNa0U3YXhpaW5RVkRqejNsZ1k5ajRMK3ZJSjZBWmVva3NsazZ2V0ZDME9VcVQ1Nk5uMHZsT0xmNThuUDNWdGFpY2x0TlptZ2h4NjJPRmRsNEdiQktvWUNvZVhGOFE4NG04WThicEZCd1R0QlM3Y01ra1JzTUJ5MDVsWjUwN1NBcTliMEVLYm5ReHNjZHlWcVJRZW9hTit3aTJJSGY4V0k1dTQxSzdPZktkNW9nNEUxT2lBKzhLZ3g0WXBFZTh1TEJwQVp1aE5LVDFzRE5zOFFRSm9FZkEmI3gzRDsmI3gzRDs8L1NpZ25hdHVyZT4gPC9LZXlPU0F1dGhlbnRpY2F0aW9uWE1MPg&#x3D;&#x3D;"
}
},
"FAIRPLAY": {"licenseUri": "https://fp-keyos.licensekeyserver.com/getkey",
"licenseHeaders": {"customdata": "PEtleU9TQXV0aGVudGljYXRpb25YTUw+IDxEYXRhPiAgIDxHZW5lcmF0aW9uVGltZT4yMDE5LTA1LTAxIDE0OjEyOjMzLjA3MDwvR2VuZXJhdGlvblRpbWU+ICAgPEV4cGlyYXRpb25UaW1lPjIwMTktMDUtMzEgMTQ6MTI6MzMuMDcwPC9FeHBpcmF0aW9uVGltZT4gICA8VW5pcXVlSWQ+ZTIwYTk0MDMtZWU2Yy00MzdiLWIwZjAtYmM4NjFhOGJjZGUwPC9VbmlxdWVJZD4gICA8UlNBUHViS2V5SWQ+NWMxNzI3MjM4OWVkNzMyMTFiNjczNDA0Zjk4NmFkMjQ8L1JTQVB1YktleUlkPiAgIDxXaWRldmluZVBvbGljeSBmbF9DYW5QbGF5PSJ0cnVlIiBmbF9DYW5QZXJzaXN0PSJmYWxzZSIgLz4gICA8V2lkZXZpbmVDb250ZW50S2V5U3BlYyBUcmFja1R5cGU9IkhEIj4gICAgIDxTZWN1cml0eUxldmVsPjE8L1NlY3VyaXR5TGV2ZWw+ICAgPC9XaWRldmluZUNvbnRlbnRLZXlTcGVjPiAgIDxGYWlyUGxheVBvbGljeSBwZXJzaXN0ZW50PSJmYWxzZSIgLz4gICA8TGljZW5zZSB0eXBlPSJzaW1wbGUiIC8+IDwvRGF0YT4gPFNpZ25hdHVyZT5hdXkxaUlkM0NRUnFuWm9tRUgxZGRIcHJnNEZhTFJJdGFFM1paS01BcjlzdmZYbVpzODhBdlFrZVdjN0MxOXZnZkNiTmNlMDNVREZTWDNLZXRIb2RXb3J6TWd0VExQdVVUdVhRNUkxRERXLzQzbDdmK3RJdnJOYjAzUkNTRVJPQytNa0U3YXhpaW5RVkRqejNsZ1k5ajRMK3ZJSjZBWmVva3NsazZ2V0ZDME9VcVQ1Nk5uMHZsT0xmNThuUDNWdGFpY2x0TlptZ2h4NjJPRmRsNEdiQktvWUNvZVhGOFE4NG04WThicEZCd1R0QlM3Y01ra1JzTUJ5MDVsWjUwN1NBcTliMEVLYm5ReHNjZHlWcVJRZW9hTit3aTJJSGY4V0k1dTQxSzdPZktkNW9nNEUxT2lBKzhLZ3g0WXBFZTh1TEJwQVp1aE5LVDFzRE5zOFFRSm9FZkEmI3gzRDsmI3gzRDs8L1NpZ25hdHVyZT4gPC9LZXlPU0F1dGhlbnRpY2F0aW9uWE1MPg&#x3D;&#x3D;"
},
"certificateUri": "https://fp-keyos.licensekeyserver.com/cert/5c17272389ed73211b673404f986ad24.der",
"certificateHeaders": {"customeheader": "customdata"
}
}
}
}
]

Movies

Returns a list of movies

Examples:

Brief & sort by rating & limit 20: /client/api/servicespec/59e5b5c4a95efa0001e28e2d/movies?brief&sort=-rating&limit=20
projection is default: /client/api/servicespec/59e5b5c4a95efa0001e28e2d/movies
projection is brief: /client/api/servicespec/59e5b5c4a95efa0001e28e2d/movies?brief
Search by title: /client/api/servicespec/59e5b5c4a95efa0001e28e2d/movies?title=/ARAB/i&sort=-rating
Pages:
- First 50: /client/api/servicespec/59e5b5c4a95efa0001e28e2d/movies
- 50-100: /client/api/servicespec/59e5b5c4a95efa0001e28e2d/movies?skip=50

query Parameters

title	string Example: title=/usa/i Search by title (regular expression)
plot	string Example: plot=/story of Alf Mabrook/i Search by plot (regular expression)
year	integer Example: year=2009 Search by year
languages	string Example: languages=5915c3941d6d2f134d699da3 Search by language ID
countries	string Example: countries=5915c3941d6d2f134d699da3 Search by country ID
genres	string Example: genres=5915c3941d6d2f134d699da3 Search by genre ID
categories	string Example: categories=5915c3941d6d2f134d699da3 Search by category ID
studios	string Example: studios=2009 TODO: fixme Search by studios (mongodb query)

Responses

Response samples

200

Content type

application/json

[{"_id": "5915c3bacc8e1e13969de081",
"title": "Alf Mabrook",
"plot": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"plotSimple": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"year": 2009,
"rating": 0.800000011920929,
"mpaaRating": "G",
"producers": ["Kamel Abu Ali",
"Mohamed Almanadely"
],
"directors": ["Ahmad Nader Jalal",
"Ahmad Jalal"
],
"cast": [{"_id": "5915c3bacc8e1e13969de086",
"name": "Ahmad Jalal"
},
{"_id": "5915c3bacc8e1e13969de087",
"name": "Ahmad Nader Jalal"
}
],
"posters": [{"path": "videotitle-poster/592624fcb7fb245a4e412021.PNG"
}
],
"backgrounds": [{"path": "videotitle-poster/592624fcb7fb245a4e412021.PNG"
}
],
"genres": ["5915c3ec201c2313ee14cb70"
],
"categories": ["5915c3941d6d2f134d699da3"
],
"countries": ["ARE"
],
"languages": ["ara"
]
}
]

Returns a movie by ID

Responses

Response samples

200

Content type

application/json

Example

Brief

{"_id": "5915c3bacc8e1e13969de081",
"title": "Alf Mabrook",
"plot": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"plotSimple": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"year": 2009,
"rating": 0.800000011920929,
"mpaaRating": "G",
"producers": ["Kamel Abu Ali",
"Mohamed Almanadely"
],
"directors": ["Ahmad Nader Jalal",
"Ahmad Jalal"
],
"cast": [{"_id": "5915c3bacc8e1e13969de086",
"name": "Ahmad Jalal"
},
{"_id": "5915c3bacc8e1e13969de087",
"name": "Ahmad Nader Jalal"
}
],
"posters": [{"path": "videotitle-poster/592624fcb7fb245a4e412021.PNG"
}
],
"backgrounds": [{"path": "videotitle-poster/592624fcb7fb245a4e412021.PNG"
}
],
"genres": ["5915c3ec201c2313ee14cb70"
],
"categories": ["5915c3941d6d2f134d699da3"
],
"countries": ["ARE"
],
"languages": ["ara"
]
}

Returns a movie by ID or IDs

Responses

Response samples

200

Content type

application/json

[{"_id": "5915c3bacc8e1e13969de081",
"title": "Alf Mabrook",
"plot": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"plotSimple": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"year": 2009,
"rating": 0.800000011920929,
"mpaaRating": "G",
"producers": ["Kamel Abu Ali",
"Mohamed Almanadely"
],
"directors": ["Ahmad Nader Jalal",
"Ahmad Jalal"
],
"cast": [{"_id": "5915c3bacc8e1e13969de086",
"name": "Ahmad Jalal"
},
{"_id": "5915c3bacc8e1e13969de087",
"name": "Ahmad Nader Jalal"
}
],
"posters": [{"path": "videotitle-poster/592624fcb7fb245a4e412021.PNG"
}
],
"backgrounds": [{"path": "videotitle-poster/592624fcb7fb245a4e412021.PNG"
}
],
"genres": ["5915c3ec201c2313ee14cb70"
],
"categories": ["5915c3941d6d2f134d699da3"
],
"countries": ["ARE"
],
"languages": ["ara"
]
}
]

Movie Source V1 Deprecated

Authorizations:

JWT

Responses

Response samples

200

Content type

application/json

[{"description": "some description",
"runtime": 6000,
"name": "A_M_LCE/204_Alf_Mabrook.mp4",
"status": "ACTIVE",
"urls": ["http://od101.cdn.lbcdn.com/vod/_definst_/mp4:vod/A_M_LCE/204_Alf_Mabrook.mp4/chunklist.m3u8?hdnts=ip=178.74.85.6~exp=1534590178482~acl=*~data=5a0d371bf6f3c100011545c8~hmac=43f27318be0700941ff08a7c561d364c241730084c4d0d98d4aa99298640d7dd"
],
"ads": {"vastUrl": "http://v.lkqd.net/ad?pid=9&sid=977875&output=vastvpaid&support=html5&execution=any&placement=&playinit=auto&volume=100&&contentid=5915c3cdfc819813c4c22bfd&contenttitle=jordannoor",
"provider": "adsense",
"options": { }
}
}
]

Movie Source V3

Authorizations:

JWT

Responses

Response samples

200
451

Content type

application/json

[{"screenRatio": 1.3333333730697632,
"volume": 100,
"description": "some description",
"runtime": 6000,
"name": "A_M_LCE/204_Alf_Mabrook.mp4",
"status": "ACTIVE",
"type": "HLS",
"drm": {"types": ["WIDEVINE",
"PLAYREADY"
],
"ttl": 43200,
"WIDEVINE": {"licenseUri": "https://wv-keyos.licensekeyserver.com/",
"licenseHeaders": {"customdata": "PEtleU9TQXV0aGVudGljYXRpb25YTUw+IDxEYXRhPiAgIDxHZW5lcmF0aW9uVGltZT4yMDE5LTA1LTA0IDExOjEwOjUzLjkwMzwvR2VuZXJhdGlvblRpbWU+ICAgPEV4cGlyYXRpb25UaW1lPjwvRXhwaXJhdGlvblRpbWU+ICAgPFVuaXF1ZUlkPjFlNTZmOGJkLTQyYTAtNDlmZC05MzAwLTVlNjk0OWJhMTlmYzwvVW5pcXVlSWQ+ICAgPFJTQVB1YktleUlkPjVjMTcyNzIzODllZDczMjExYjY3MzQwNGY5ODZhZDI0PC9SU0FQdWJLZXlJZD4gICA8V2lkZXZpbmVQb2xpY3kgZmxfQ2FuUGxheT0idHJ1ZSIgZmxfQ2FuUGVyc2lzdD0iZmFsc2UiIC8+ICAgPFdpZGV2aW5lQ29udGVudEtleVNwZWMgVHJhY2tUeXBlPSJIRCI+ICAgICA8U2VjdXJpdHlMZXZlbD4xPC9TZWN1cml0eUxldmVsPiAgIDwvV2lkZXZpbmVDb250ZW50S2V5U3BlYz4gICA8RmFpclBsYXlQb2xpY3kgcGVyc2lzdGVudD0iZmFsc2UiIC8+ICAgPExpY2Vuc2UgdHlwZT0ic2ltcGxlIiAvPiA8L0RhdGE+IDxTaWduYXR1cmU+ZGhjWWRNL25NL0FLekFFMEg2bHhFT00vMldqN3djUWo0UGtXNTdzY1Jhd0VDRU5WcnpWRXgxc1ZPNk9RNVpweDJQM0thOWhIcVllbDlMYThyMHRnelhVRFRNSU9acHVxYnM1UWxZenJPRmg5N1VHOGI4a2tWYUw4VHVwdVBOcHlCdmlTQXlSUEsydDlTVmppNkw2OXAzT0NvdUcyOHRmT0wrQlhVSUtMS2MwQldacE1IUmNYYnZPQjk1UHVlS1VoaUUraWUzWjJpUDhkYnA5MHAvc2JsdWthaE1PUzlmbkpIZ084U3psckhxUEtBTkQyRWVLTFdYQUg1UHNielJsNHhPcUQzS2kwdlBDd2FJTHIrLzhJT3J1TmJ4aWIrQ1Q1UFI4OVBQOUw1bzc5Z1g4Ym56Zktud1RNUUpOSTlIRHlxTTNMczdyeEFCNVZIdnI2cE51R0l3JiN4M0Q7JiN4M0Q7PC9TaWduYXR1cmU+IDwvS2V5T1NBdXRoZW50aWNhdGlvblhNTD4&#x3D;"
}
},
"PLAYREADY": {"licenseUri": "https://pr-keyos.licensekeyserver.com/core/rightsmanager.asmx",
"licenseHeaders": {"customdata": "PEtleU9TQXV0aGVudGljYXRpb25YTUw+IDxEYXRhPiAgIDxHZW5lcmF0aW9uVGltZT4yMDE5LTA1LTA0IDExOjEwOjUzLjkwMzwvR2VuZXJhdGlvblRpbWU+ICAgPEV4cGlyYXRpb25UaW1lPjwvRXhwaXJhdGlvblRpbWU+ICAgPFVuaXF1ZUlkPjFlNTZmOGJkLTQyYTAtNDlmZC05MzAwLTVlNjk0OWJhMTlmYzwvVW5pcXVlSWQ+ICAgPFJTQVB1YktleUlkPjVjMTcyNzIzODllZDczMjExYjY3MzQwNGY5ODZhZDI0PC9SU0FQdWJLZXlJZD4gICA8V2lkZXZpbmVQb2xpY3kgZmxfQ2FuUGxheT0idHJ1ZSIgZmxfQ2FuUGVyc2lzdD0iZmFsc2UiIC8+ICAgPFdpZGV2aW5lQ29udGVudEtleVNwZWMgVHJhY2tUeXBlPSJIRCI+ICAgICA8U2VjdXJpdHlMZXZlbD4xPC9TZWN1cml0eUxldmVsPiAgIDwvV2lkZXZpbmVDb250ZW50S2V5U3BlYz4gICA8RmFpclBsYXlQb2xpY3kgcGVyc2lzdGVudD0iZmFsc2UiIC8+ICAgPExpY2Vuc2UgdHlwZT0ic2ltcGxlIiAvPiA8L0RhdGE+IDxTaWduYXR1cmU+ZGhjWWRNL25NL0FLekFFMEg2bHhFT00vMldqN3djUWo0UGtXNTdzY1Jhd0VDRU5WcnpWRXgxc1ZPNk9RNVpweDJQM0thOWhIcVllbDlMYThyMHRnelhVRFRNSU9acHVxYnM1UWxZenJPRmg5N1VHOGI4a2tWYUw4VHVwdVBOcHlCdmlTQXlSUEsydDlTVmppNkw2OXAzT0NvdUcyOHRmT0wrQlhVSUtMS2MwQldacE1IUmNYYnZPQjk1UHVlS1VoaUUraWUzWjJpUDhkYnA5MHAvc2JsdWthaE1PUzlmbkpIZ084U3psckhxUEtBTkQyRWVLTFdYQUg1UHNielJsNHhPcUQzS2kwdlBDd2FJTHIrLzhJT3J1TmJ4aWIrQ1Q1UFI4OVBQOUw1bzc5Z1g4Ym56Zktud1RNUUpOSTlIRHlxTTNMczdyeEFCNVZIdnI2cE51R0l3JiN4M0Q7JiN4M0Q7PC9TaWduYXR1cmU+IDwvS2V5T1NBdXRoZW50aWNhdGlvblhNTD4&#x3D;"
}
},
"FAIRPLAY": {"licenseUri": "https://fp-keyos.licensekeyserver.com/getkey",
"licenseHeaders": {"customdata": "PEtleU9TQXV0aGVudGljYXRpb25YTUw+IDxEYXRhPiAgIDxHZW5lcmF0aW9uVGltZT4yMDE5LTA1LTA0IDExOjEwOjUzLjkwMzwvR2VuZXJhdGlvblRpbWU+ICAgPEV4cGlyYXRpb25UaW1lPjwvRXhwaXJhdGlvblRpbWU+ICAgPFVuaXF1ZUlkPjFlNTZmOGJkLTQyYTAtNDlmZC05MzAwLTVlNjk0OWJhMTlmYzwvVW5pcXVlSWQ+ICAgPFJTQVB1YktleUlkPjVjMTcyNzIzODllZDczMjExYjY3MzQwNGY5ODZhZDI0PC9SU0FQdWJLZXlJZD4gICA8V2lkZXZpbmVQb2xpY3kgZmxfQ2FuUGxheT0idHJ1ZSIgZmxfQ2FuUGVyc2lzdD0iZmFsc2UiIC8+ICAgPFdpZGV2aW5lQ29udGVudEtleVNwZWMgVHJhY2tUeXBlPSJIRCI+ICAgICA8U2VjdXJpdHlMZXZlbD4xPC9TZWN1cml0eUxldmVsPiAgIDwvV2lkZXZpbmVDb250ZW50S2V5U3BlYz4gICA8RmFpclBsYXlQb2xpY3kgcGVyc2lzdGVudD0iZmFsc2UiIC8+ICAgPExpY2Vuc2UgdHlwZT0ic2ltcGxlIiAvPiA8L0RhdGE+IDxTaWduYXR1cmU+ZGhjWWRNL25NL0FLekFFMEg2bHhFT00vMldqN3djUWo0UGtXNTdzY1Jhd0VDRU5WcnpWRXgxc1ZPNk9RNVpweDJQM0thOWhIcVllbDlMYThyMHRnelhVRFRNSU9acHVxYnM1UWxZenJPRmg5N1VHOGI4a2tWYUw4VHVwdVBOcHlCdmlTQXlSUEsydDlTVmppNkw2OXAzT0NvdUcyOHRmT0wrQlhVSUtMS2MwQldacE1IUmNYYnZPQjk1UHVlS1VoaUUraWUzWjJpUDhkYnA5MHAvc2JsdWthaE1PUzlmbkpIZ084U3psckhxUEtBTkQyRWVLTFdYQUg1UHNielJsNHhPcUQzS2kwdlBDd2FJTHIrLzhJT3J1TmJ4aWIrQ1Q1UFI4OVBQOUw1bzc5Z1g4Ym56Zktud1RNUUpOSTlIRHlxTTNMczdyeEFCNVZIdnI2cE51R0l3JiN4M0Q7JiN4M0Q7PC9TaWduYXR1cmU+IDwvS2V5T1NBdXRoZW50aWNhdGlvblhNTD4&#x3D;"
},
"certificateUri": "https://fp-keyos.licensekeyserver.com/cert/5c17272389ed73211b673404f986ad24.der",
"certificateHeaders": {"customeheader": "customdata"
}
}
},
"sources": [{"src": "http://od101.cdn.lbcdn.com/vod/_definst_/mp4:vod/A_M_LCE/204_Alf_Mabrook.mp4/chunklist.m3u8?hdnts=ip=178.74.85.6~exp=1534590178482~acl=*~data=5a0d371bf6f3c100011545c8~hmac=43f27318be0700941ff08a7c561d364c241730084c4d0d98d4aa99298640d7dd",
"priority": 10,
"protocol": "HTTP",
"ttl": 3600
}
],
"ads": {"vastUrl": "http://v.lkqd.net/ad?pid=9&sid=977875&output=vastvpaid&support=html5&execution=any&placement=&playinit=auto&volume=100&&contentid=5915c3cdfc819813c4c22bfd&contenttitle=jordannoor",
"provider": "adsense",
"options": { }
}
}
]

Movie Trailer V1 Deprecated

Authorizations:

JWT

Responses

Response samples

200

Content type

application/json

{"description": "some description",
"runtime": 6000,
"name": "A_M_LCE/204_Alf_Mabrook.mp4",
"status": "ACTIVE",
"urls": ["http://od101.cdn.lbcdn.com/vod/_definst_/mp4:vod/A_M_LCE/204_Alf_Mabrook.mp4/chunklist.m3u8?hdnts=ip=178.74.85.6~exp=1534590178482~acl=*~data=5a0d371bf6f3c100011545c8~hmac=43f27318be0700941ff08a7c561d364c241730084c4d0d98d4aa99298640d7dd"
]
}

Movie Trailer v3

Authorizations:

JWT

Responses

Response samples

200
451

Content type

application/json

{"screenRatio": 1.3333333730697632,
"volume": 100,
"description": "some description",
"runtime": 6000,
"name": "A_M_LCE/204_Alf_Mabrook.mp4",
"status": "ACTIVE",
"type": "HLS",
"sources": [{"src": "http://od101.cdn.lbcdn.com/vod/_definst_/mp4:vod/A_M_LCE/204_Alf_Mabrook.mp4/chunklist.m3u8?hdnts=ip=178.74.85.6~exp=1534590178482~acl=*~data=5a0d371bf6f3c100011545c8~hmac=43f27318be0700941ff08a7c561d364c241730084c4d0d98d4aa99298640d7dd",
"priority": 10,
"protocol": "HTTP",
"ttl": 3600
}
]
}

Movie Related

Responses

Response samples

200

Content type

application/json

[{"_id": "5915c3bacc8e1e13969de081",
"title": "Alf Mabrook",
"plot": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"plotSimple": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"year": 2009,
"rating": 0.800000011920929,
"mpaaRating": "G",
"producers": ["Kamel Abu Ali",
"Mohamed Almanadely"
],
"directors": ["Ahmad Nader Jalal",
"Ahmad Jalal"
],
"cast": [{"_id": "5915c3bacc8e1e13969de086",
"name": "Ahmad Jalal"
},
{"_id": "5915c3bacc8e1e13969de087",
"name": "Ahmad Nader Jalal"
}
],
"posters": [{"path": "videotitle-poster/592624fcb7fb245a4e412021.PNG"
}
],
"backgrounds": [{"path": "videotitle-poster/592624fcb7fb245a4e412021.PNG"
}
],
"genres": ["5915c3ec201c2313ee14cb70"
],
"categories": ["5915c3941d6d2f134d699da3"
],
"countries": ["ARE"
],
"languages": ["ara"
]
}
]

Movie Categories

Responses

Response samples

200

Content type

application/json

[{"_id": "592672a1b7fb245a4e417c0b",
"title": "Arabic Movies",
"description": "Some description",
"order": 1,
"rating": 0.694526195526123,
"posters": [{"_id": "592672a1b7fb245a4e417c0b",
"title": "Arabic Movies",
"path": "category-poster/5922f5aeb7fb245a4e400291.PNG",
"width": 160,
"height": 160
}
],
"backgrounds": [{"_id": "592672a1b7fb245a4e417c0b",
"title": "Arabic Movies",
"path": "category-poster/5922f5aeb7fb245a4e400291.PNG",
"width": 160,
"height": 160
}
]
}
]

Movie Languages

Examples:

Default: /client/api/servicespec/59e5b5c4a95efa0001e28e2d/movie/languages
Posters: /client/api/servicespec/59e5b5c4a95efa0001e28e2d/movie/languages?posters
Cards: /client/api/servicespec/59e5b5c4a95efa0001e28e2d/movie/languages?cards

Responses

Response samples

200

Content type

application/json

[{"_id": "bul",
"name": "Bulgarian",
"order": 1,
"images": [{"_id": "5a4f232959cc7d08a23d76b2",
"title": "poster",
"path": "language-image/poster-ara.png"
}
]
}
]

Movie Genres

Responses

Response samples

200

Content type

application/json

[{"_id": "5915c3ec201c2313ee14cb70",
"title": "Arabic Comedy",
"description": "Some description",
"order": 1,
"rating": 0.9526172876358032,
"posters": [{"_id": "592672a1b7fb245a4e417c0b",
"title": "Arabic Movies",
"path": "category-poster/5922f5aeb7fb245a4e400291.PNG",
"width": 160,
"height": 160
}
],
"backgrounds": [{"_id": "592672a1b7fb245a4e417c0b",
"title": "Arabic Movies",
"path": "category-poster/5922f5aeb7fb245a4e400291.PNG",
"width": 160,
"height": 160
}
]
}
]

Movie Countries

Examples:

Default: /client/api/servicespec/5915c39c1d6d2f134d69afb1/movie/countries
Posters: /client/api/servicespec/5915c39c1d6d2f134d69afb1/movie/countries?posters
Cards: /client/api/servicespec/5915c39c1d6d2f134d69afb1/movie/countries?cards

Responses

Response samples

200

Content type

application/json

[{"_id": "GRC",
"commonName": "Greece"
}
]

TvShows

Returns a list of tv shows

Examples:

Sort by rating & limit 20: /client/api/servicespec/59e5b5c4a95efa0001e28e2d/tv-shows?sort=-rating&limit=20
Search by title: /client/api/servicespec/59e5b5c4a95efa0001e28e2d/tv-shows?title=/ARAB/i&sort=-rating
Pages:
- First 50: /client/api/servicespec/59e5b5c4a95efa0001e28e2d/tv-shows
- 50-100: /client/api/servicespec/59e5b5c4a95efa0001e28e2d/tv-shows?skip=50

query Parameters

title	string Example: title=/usa/i Search by title (regular expression)
plot	string Example: plot=/story of Alf Mabrook/i Search by plot (regular expression)
year	integer Example: year=2009 Search by year
languages	string Example: languages=5915c3941d6d2f134d699da3 Search by language ID
countries	string Example: countries=5915c3941d6d2f134d699da3 Search by country ID
genres	string Example: genres=5915c3941d6d2f134d699da3 Search by genre ID
categories	string Example: categories=5915c3941d6d2f134d699da3 Search by category ID
studios	string Example: studios=2009 TODO: fixme Search by studios (mongodb query)
expand	boolean Default: false Example: expand=true Add seasons/episodes to response

Responses

Response samples

200

Content type

application/json

[{"_id": "5915c3bacc8e1e13969de081",
"type": "TV_SHOW",
"title": "Alf Mabrook",
"plot": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"plotSimple": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"year": 2009,
"rating": 0.800000011920929,
"mpaaRating": "G",
"producers": ["Kamel Abu Ali",
"Mohamed Almanadely"
],
"directors": ["Ahmad Nader Jalal",
"Ahmad Jalal"
],
"screenshots": [{"_id": null,
"width": null,
"height": null,
"path": null,
"title": null
}
],
"trailers": [{"_id": "5915c3bbcc8e1e13969de2d9",
"title": "Trailer",
"image": {"_id": null,
"width": null,
"height": null,
"path": null,
"title": null
},
"description": "some description",
"runtime": 3600,
"name": "A_M_LCE/202_Zoag_Taht_El_Talab.mp4",
"status": "ACTIVE",
"screenRatio": 1.3333333730697632,
"volume": 100
}
],
"cast": [{"_id": "5915c3bacc8e1e13969de086",
"name": "Ahmad Jalal"
},
{"_id": "5915c3bacc8e1e13969de087",
"name": "Ahmad Nader Jalal"
}
],
"genres": ["5915c3ec201c2313ee14cb70"
],
"categories": ["5915c3941d6d2f134d699da3"
],
"countries": ["ARE"
],
"languages": ["ara"
]
}
]

Returns a TV Show by ID

Responses

Response samples

200

Content type

application/json

{"_id": "5915c3bacc8e1e13969de081",
"type": "TV_SHOW",
"title": "Alf Mabrook",
"plot": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"plotSimple": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"year": 2009,
"rating": 0.800000011920929,
"mpaaRating": "G",
"producers": ["Kamel Abu Ali",
"Mohamed Almanadely"
],
"directors": ["Ahmad Nader Jalal",
"Ahmad Jalal"
],
"screenshots": [{"_id": null,
"width": null,
"height": null,
"path": null,
"title": null
}
],
"trailers": [{"_id": "5915c3bbcc8e1e13969de2d9",
"title": "Trailer",
"image": {"_id": null,
"width": null,
"height": null,
"path": null,
"title": null
},
"description": "some description",
"runtime": 3600,
"name": "A_M_LCE/202_Zoag_Taht_El_Talab.mp4",
"status": "ACTIVE",
"screenRatio": 1.3333333730697632,
"volume": 100
}
],
"cast": [{"_id": "5915c3bacc8e1e13969de086",
"name": "Ahmad Jalal"
},
{"_id": "5915c3bacc8e1e13969de087",
"name": "Ahmad Nader Jalal"
}
],
"genres": ["5915c3ec201c2313ee14cb70"
],
"categories": ["5915c3941d6d2f134d699da3"
],
"countries": ["ARE"
],
"languages": ["ara"
],
"seasons": [{"_id": "5915c3bacc8e1e13969de081",
"type": "TV_SHOW_SEASON",
"title": "Alf Mabrook",
"plot": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"plotSimple": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"year": 2009,
"rating": 0.800000011920929,
"mpaaRating": "G",
"producers": ["Kamel Abu Ali",
"Mohamed Almanadely"
],
"directors": ["Ahmad Nader Jalal",
"Ahmad Jalal"
],
"screenshots": [{"_id": null,
"width": null,
"height": null,
"path": null,
"title": null
}
],
"trailers": [{"_id": "5915c3bbcc8e1e13969de2d9",
"title": "Trailer",
"image": {"_id": null,
"width": null,
"height": null,
"path": null,
"title": null
},
"description": "some description",
"runtime": 3600,
"name": "A_M_LCE/202_Zoag_Taht_El_Talab.mp4",
"status": "ACTIVE",
"screenRatio": 1.3333333730697632,
"volume": 100
}
],
"cast": [{"_id": "5915c3bacc8e1e13969de086",
"name": "Ahmad Jalal"
},
{"_id": "5915c3bacc8e1e13969de087",
"name": "Ahmad Nader Jalal"
}
],
"genres": ["5915c3ec201c2313ee14cb70"
],
"categories": ["5915c3941d6d2f134d699da3"
],
"countries": ["ARE"
],
"languages": ["ara"
]
}
]
}

Returns a TV Show by ID or IDs

query Parameters

expand

boolean

Default: false

Example: expand=true

Add episodes to response

Responses

Response samples

200

Content type

application/json

[{"_id": "5915c3bacc8e1e13969de081",
"type": "TV_SHOW",
"title": "Alf Mabrook",
"plot": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"plotSimple": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"year": 2009,
"rating": 0.800000011920929,
"mpaaRating": "G",
"producers": ["Kamel Abu Ali",
"Mohamed Almanadely"
],
"directors": ["Ahmad Nader Jalal",
"Ahmad Jalal"
],
"screenshots": [{"_id": null,
"width": null,
"height": null,
"path": null,
"title": null
}
],
"trailers": [{"_id": "5915c3bbcc8e1e13969de2d9",
"title": "Trailer",
"image": {"_id": null,
"width": null,
"height": null,
"path": null,
"title": null
},
"description": "some description",
"runtime": 3600,
"name": "A_M_LCE/202_Zoag_Taht_El_Talab.mp4",
"status": "ACTIVE",
"screenRatio": 1.3333333730697632,
"volume": 100
}
],
"cast": [{"_id": "5915c3bacc8e1e13969de086",
"name": "Ahmad Jalal"
},
{"_id": "5915c3bacc8e1e13969de087",
"name": "Ahmad Nader Jalal"
}
],
"genres": ["5915c3ec201c2313ee14cb70"
],
"categories": ["5915c3941d6d2f134d699da3"
],
"countries": ["ARE"
],
"languages": ["ara"
],
"seasons": [{"_id": "5915c3bacc8e1e13969de081",
"type": "TV_SHOW_SEASON",
"title": "Alf Mabrook",
"plot": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"plotSimple": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"year": 2009,
"rating": 0.800000011920929,
"mpaaRating": "G",
"producers": ["Kamel Abu Ali",
"Mohamed Almanadely"
],
"directors": ["Ahmad Nader Jalal",
"Ahmad Jalal"
],
"screenshots": [{"_id": null,
"width": null,
"height": null,
"path": null,
"title": null
}
],
"trailers": [{"_id": "5915c3bbcc8e1e13969de2d9",
"title": "Trailer",
"image": {"_id": null,
"width": null,
"height": null,
"path": null,
"title": null
},
"description": "some description",
"runtime": 3600,
"name": "A_M_LCE/202_Zoag_Taht_El_Talab.mp4",
"status": "ACTIVE",
"screenRatio": 1.3333333730697632,
"volume": 100
}
],
"cast": [{"_id": "5915c3bacc8e1e13969de086",
"name": "Ahmad Jalal"
},
{"_id": "5915c3bacc8e1e13969de087",
"name": "Ahmad Nader Jalal"
}
],
"genres": ["5915c3ec201c2313ee14cb70"
],
"categories": ["5915c3941d6d2f134d699da3"
],
"countries": ["ARE"
],
"languages": ["ara"
]
}
]
}
]

Returns a Season by ID

Responses

Response samples

200

Content type

application/json

{"_id": "5915c3bacc8e1e13969de081",
"type": "TV_SHOW_SEASON",
"title": "Alf Mabrook",
"plot": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"plotSimple": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"year": 2009,
"rating": 0.800000011920929,
"mpaaRating": "G",
"producers": ["Kamel Abu Ali",
"Mohamed Almanadely"
],
"directors": ["Ahmad Nader Jalal",
"Ahmad Jalal"
],
"screenshots": [{"_id": null,
"width": null,
"height": null,
"path": null,
"title": null
}
],
"trailers": [{"_id": "5915c3bbcc8e1e13969de2d9",
"title": "Trailer",
"image": {"_id": null,
"width": null,
"height": null,
"path": null,
"title": null
},
"description": "some description",
"runtime": 3600,
"name": "A_M_LCE/202_Zoag_Taht_El_Talab.mp4",
"status": "ACTIVE",
"screenRatio": 1.3333333730697632,
"volume": 100
}
],
"cast": [{"_id": "5915c3bacc8e1e13969de086",
"name": "Ahmad Jalal"
},
{"_id": "5915c3bacc8e1e13969de087",
"name": "Ahmad Nader Jalal"
}
],
"genres": ["5915c3ec201c2313ee14cb70"
],
"categories": ["5915c3941d6d2f134d699da3"
],
"countries": ["ARE"
],
"languages": ["ara"
],
"episodes": [{"_id": "5915c3bacc8e1e13969de081",
"type": "TV_SHOW_EPISODE",
"title": "Alf Mabrook",
"plot": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"plotSimple": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"year": 2009,
"rating": 0.800000011920929,
"mpaaRating": "G",
"producers": ["Kamel Abu Ali",
"Mohamed Almanadely"
],
"directors": ["Ahmad Nader Jalal",
"Ahmad Jalal"
],
"screenshots": [{"_id": null,
"width": null,
"height": null,
"path": null,
"title": null
}
],
"trailers": [{"_id": "5915c3bbcc8e1e13969de2d9",
"title": "Trailer",
"image": {"_id": null,
"width": null,
"height": null,
"path": null,
"title": null
},
"description": "some description",
"runtime": 3600,
"name": "A_M_LCE/202_Zoag_Taht_El_Talab.mp4",
"status": "ACTIVE",
"screenRatio": 1.3333333730697632,
"volume": 100
}
],
"cast": [{"_id": "5915c3bacc8e1e13969de086",
"name": "Ahmad Jalal"
},
{"_id": "5915c3bacc8e1e13969de087",
"name": "Ahmad Nader Jalal"
}
],
"genres": ["5915c3ec201c2313ee14cb70"
],
"categories": ["5915c3941d6d2f134d699da3"
],
"countries": ["ARE"
],
"languages": ["ara"
]
}
]
}

Returns an Episode by ID

Responses

Response samples

200

Content type

application/json

{"_id": "5915c3bacc8e1e13969de081",
"type": "TV_SHOW_EPISODE",
"title": "Alf Mabrook",
"plot": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"plotSimple": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"year": 2009,
"rating": 0.800000011920929,
"mpaaRating": "G",
"producers": ["Kamel Abu Ali",
"Mohamed Almanadely"
],
"directors": ["Ahmad Nader Jalal",
"Ahmad Jalal"
],
"screenshots": [{"_id": null,
"width": null,
"height": null,
"path": null,
"title": null
}
],
"trailers": [{"_id": "5915c3bbcc8e1e13969de2d9",
"title": "Trailer",
"image": {"_id": null,
"width": null,
"height": null,
"path": null,
"title": null
},
"description": "some description",
"runtime": 3600,
"name": "A_M_LCE/202_Zoag_Taht_El_Talab.mp4",
"status": "ACTIVE",
"screenRatio": 1.3333333730697632,
"volume": 100
}
],
"cast": [{"_id": "5915c3bacc8e1e13969de086",
"name": "Ahmad Jalal"
},
{"_id": "5915c3bacc8e1e13969de087",
"name": "Ahmad Nader Jalal"
}
],
"genres": ["5915c3ec201c2313ee14cb70"
],
"categories": ["5915c3941d6d2f134d699da3"
],
"countries": ["ARE"
],
"languages": ["ara"
],
"parent": {"_id": "5915c3bacc8e1e13969de081",
"type": "TV_SHOW_SEASON",
"title": "Alf Mabrook",
"plot": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"plotSimple": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"year": 2009,
"rating": 0.800000011920929,
"mpaaRating": "G",
"producers": ["Kamel Abu Ali",
"Mohamed Almanadely"
],
"directors": ["Ahmad Nader Jalal",
"Ahmad Jalal"
],
"screenshots": [{"_id": null,
"width": null,
"height": null,
"path": null,
"title": null
}
],
"trailers": [{"_id": "5915c3bbcc8e1e13969de2d9",
"title": "Trailer",
"image": {"_id": null,
"width": null,
"height": null,
"path": null,
"title": null
},
"description": "some description",
"runtime": 3600,
"name": "A_M_LCE/202_Zoag_Taht_El_Talab.mp4",
"status": "ACTIVE",
"screenRatio": 1.3333333730697632,
"volume": 100
}
],
"cast": [{"_id": "5915c3bacc8e1e13969de086",
"name": "Ahmad Jalal"
},
{"_id": "5915c3bacc8e1e13969de087",
"name": "Ahmad Nader Jalal"
}
],
"genres": ["5915c3ec201c2313ee14cb70"
],
"categories": ["5915c3941d6d2f134d699da3"
],
"countries": ["ARE"
],
"languages": ["ara"
],
"parent": {"_id": "5915c3bacc8e1e13969de081",
"type": "TV_SHOW",
"title": "Alf Mabrook",
"plot": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"plotSimple": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"year": 2009,
"rating": 0.800000011920929,
"mpaaRating": "G",
"producers": ["Kamel Abu Ali",
"Mohamed Almanadely"
],
"directors": ["Ahmad Nader Jalal",
"Ahmad Jalal"
],
"screenshots": [{"_id": null,
"width": null,
"height": null,
"path": null,
"title": null
}
],
"trailers": [{"_id": "5915c3bbcc8e1e13969de2d9",
"title": "Trailer",
"image": {"_id": null,
"width": null,
"height": null,
"path": null,
"title": null
},
"description": "some description",
"runtime": 3600,
"name": "A_M_LCE/202_Zoag_Taht_El_Talab.mp4",
"status": "ACTIVE",
"screenRatio": 1.3333333730697632,
"volume": 100
}
],
"cast": [{"_id": "5915c3bacc8e1e13969de086",
"name": "Ahmad Jalal"
},
{"_id": "5915c3bacc8e1e13969de087",
"name": "Ahmad Nader Jalal"
}
],
"genres": ["5915c3ec201c2313ee14cb70"
],
"categories": ["5915c3941d6d2f134d699da3"
],
"countries": ["ARE"
],
"languages": ["ara"
]
}
}
}

TV Show Source V3

Authorizations:

JWT

Responses

Response samples

200
451

Content type

application/json

[{"screenRatio": 1.3333333730697632,
"volume": 100,
"description": "some description",
"runtime": 6000,
"name": "A_M_LCE/204_Alf_Mabrook.mp4",
"status": "ACTIVE",
"type": "HLS",
"drm": {"types": ["WIDEVINE",
"PLAYREADY"
],
"ttl": 43200,
"WIDEVINE": {"licenseUri": "https://wv-keyos.licensekeyserver.com/",
"licenseHeaders": {"customdata": "PEtleU9TQXV0aGVudGljYXRpb25YTUw+IDxEYXRhPiAgIDxHZW5lcmF0aW9uVGltZT4yMDE5LTA1LTA0IDExOjEwOjUzLjkwMzwvR2VuZXJhdGlvblRpbWU+ICAgPEV4cGlyYXRpb25UaW1lPjwvRXhwaXJhdGlvblRpbWU+ICAgPFVuaXF1ZUlkPjFlNTZmOGJkLTQyYTAtNDlmZC05MzAwLTVlNjk0OWJhMTlmYzwvVW5pcXVlSWQ+ICAgPFJTQVB1YktleUlkPjVjMTcyNzIzODllZDczMjExYjY3MzQwNGY5ODZhZDI0PC9SU0FQdWJLZXlJZD4gICA8V2lkZXZpbmVQb2xpY3kgZmxfQ2FuUGxheT0idHJ1ZSIgZmxfQ2FuUGVyc2lzdD0iZmFsc2UiIC8+ICAgPFdpZGV2aW5lQ29udGVudEtleVNwZWMgVHJhY2tUeXBlPSJIRCI+ICAgICA8U2VjdXJpdHlMZXZlbD4xPC9TZWN1cml0eUxldmVsPiAgIDwvV2lkZXZpbmVDb250ZW50S2V5U3BlYz4gICA8RmFpclBsYXlQb2xpY3kgcGVyc2lzdGVudD0iZmFsc2UiIC8+ICAgPExpY2Vuc2UgdHlwZT0ic2ltcGxlIiAvPiA8L0RhdGE+IDxTaWduYXR1cmU+ZGhjWWRNL25NL0FLekFFMEg2bHhFT00vMldqN3djUWo0UGtXNTdzY1Jhd0VDRU5WcnpWRXgxc1ZPNk9RNVpweDJQM0thOWhIcVllbDlMYThyMHRnelhVRFRNSU9acHVxYnM1UWxZenJPRmg5N1VHOGI4a2tWYUw4VHVwdVBOcHlCdmlTQXlSUEsydDlTVmppNkw2OXAzT0NvdUcyOHRmT0wrQlhVSUtMS2MwQldacE1IUmNYYnZPQjk1UHVlS1VoaUUraWUzWjJpUDhkYnA5MHAvc2JsdWthaE1PUzlmbkpIZ084U3psckhxUEtBTkQyRWVLTFdYQUg1UHNielJsNHhPcUQzS2kwdlBDd2FJTHIrLzhJT3J1TmJ4aWIrQ1Q1UFI4OVBQOUw1bzc5Z1g4Ym56Zktud1RNUUpOSTlIRHlxTTNMczdyeEFCNVZIdnI2cE51R0l3JiN4M0Q7JiN4M0Q7PC9TaWduYXR1cmU+IDwvS2V5T1NBdXRoZW50aWNhdGlvblhNTD4&#x3D;"
}
},
"PLAYREADY": {"licenseUri": "https://pr-keyos.licensekeyserver.com/core/rightsmanager.asmx",
"licenseHeaders": {"customdata": "PEtleU9TQXV0aGVudGljYXRpb25YTUw+IDxEYXRhPiAgIDxHZW5lcmF0aW9uVGltZT4yMDE5LTA1LTA0IDExOjEwOjUzLjkwMzwvR2VuZXJhdGlvblRpbWU+ICAgPEV4cGlyYXRpb25UaW1lPjwvRXhwaXJhdGlvblRpbWU+ICAgPFVuaXF1ZUlkPjFlNTZmOGJkLTQyYTAtNDlmZC05MzAwLTVlNjk0OWJhMTlmYzwvVW5pcXVlSWQ+ICAgPFJTQVB1YktleUlkPjVjMTcyNzIzODllZDczMjExYjY3MzQwNGY5ODZhZDI0PC9SU0FQdWJLZXlJZD4gICA8V2lkZXZpbmVQb2xpY3kgZmxfQ2FuUGxheT0idHJ1ZSIgZmxfQ2FuUGVyc2lzdD0iZmFsc2UiIC8+ICAgPFdpZGV2aW5lQ29udGVudEtleVNwZWMgVHJhY2tUeXBlPSJIRCI+ICAgICA8U2VjdXJpdHlMZXZlbD4xPC9TZWN1cml0eUxldmVsPiAgIDwvV2lkZXZpbmVDb250ZW50S2V5U3BlYz4gICA8RmFpclBsYXlQb2xpY3kgcGVyc2lzdGVudD0iZmFsc2UiIC8+ICAgPExpY2Vuc2UgdHlwZT0ic2ltcGxlIiAvPiA8L0RhdGE+IDxTaWduYXR1cmU+ZGhjWWRNL25NL0FLekFFMEg2bHhFT00vMldqN3djUWo0UGtXNTdzY1Jhd0VDRU5WcnpWRXgxc1ZPNk9RNVpweDJQM0thOWhIcVllbDlMYThyMHRnelhVRFRNSU9acHVxYnM1UWxZenJPRmg5N1VHOGI4a2tWYUw4VHVwdVBOcHlCdmlTQXlSUEsydDlTVmppNkw2OXAzT0NvdUcyOHRmT0wrQlhVSUtMS2MwQldacE1IUmNYYnZPQjk1UHVlS1VoaUUraWUzWjJpUDhkYnA5MHAvc2JsdWthaE1PUzlmbkpIZ084U3psckhxUEtBTkQyRWVLTFdYQUg1UHNielJsNHhPcUQzS2kwdlBDd2FJTHIrLzhJT3J1TmJ4aWIrQ1Q1UFI4OVBQOUw1bzc5Z1g4Ym56Zktud1RNUUpOSTlIRHlxTTNMczdyeEFCNVZIdnI2cE51R0l3JiN4M0Q7JiN4M0Q7PC9TaWduYXR1cmU+IDwvS2V5T1NBdXRoZW50aWNhdGlvblhNTD4&#x3D;"
}
},
"FAIRPLAY": {"licenseUri": "https://fp-keyos.licensekeyserver.com/getkey",
"licenseHeaders": {"customdata": "PEtleU9TQXV0aGVudGljYXRpb25YTUw+IDxEYXRhPiAgIDxHZW5lcmF0aW9uVGltZT4yMDE5LTA1LTA0IDExOjEwOjUzLjkwMzwvR2VuZXJhdGlvblRpbWU+ICAgPEV4cGlyYXRpb25UaW1lPjwvRXhwaXJhdGlvblRpbWU+ICAgPFVuaXF1ZUlkPjFlNTZmOGJkLTQyYTAtNDlmZC05MzAwLTVlNjk0OWJhMTlmYzwvVW5pcXVlSWQ+ICAgPFJTQVB1YktleUlkPjVjMTcyNzIzODllZDczMjExYjY3MzQwNGY5ODZhZDI0PC9SU0FQdWJLZXlJZD4gICA8V2lkZXZpbmVQb2xpY3kgZmxfQ2FuUGxheT0idHJ1ZSIgZmxfQ2FuUGVyc2lzdD0iZmFsc2UiIC8+ICAgPFdpZGV2aW5lQ29udGVudEtleVNwZWMgVHJhY2tUeXBlPSJIRCI+ICAgICA8U2VjdXJpdHlMZXZlbD4xPC9TZWN1cml0eUxldmVsPiAgIDwvV2lkZXZpbmVDb250ZW50S2V5U3BlYz4gICA8RmFpclBsYXlQb2xpY3kgcGVyc2lzdGVudD0iZmFsc2UiIC8+ICAgPExpY2Vuc2UgdHlwZT0ic2ltcGxlIiAvPiA8L0RhdGE+IDxTaWduYXR1cmU+ZGhjWWRNL25NL0FLekFFMEg2bHhFT00vMldqN3djUWo0UGtXNTdzY1Jhd0VDRU5WcnpWRXgxc1ZPNk9RNVpweDJQM0thOWhIcVllbDlMYThyMHRnelhVRFRNSU9acHVxYnM1UWxZenJPRmg5N1VHOGI4a2tWYUw4VHVwdVBOcHlCdmlTQXlSUEsydDlTVmppNkw2OXAzT0NvdUcyOHRmT0wrQlhVSUtMS2MwQldacE1IUmNYYnZPQjk1UHVlS1VoaUUraWUzWjJpUDhkYnA5MHAvc2JsdWthaE1PUzlmbkpIZ084U3psckhxUEtBTkQyRWVLTFdYQUg1UHNielJsNHhPcUQzS2kwdlBDd2FJTHIrLzhJT3J1TmJ4aWIrQ1Q1UFI4OVBQOUw1bzc5Z1g4Ym56Zktud1RNUUpOSTlIRHlxTTNMczdyeEFCNVZIdnI2cE51R0l3JiN4M0Q7JiN4M0Q7PC9TaWduYXR1cmU+IDwvS2V5T1NBdXRoZW50aWNhdGlvblhNTD4&#x3D;"
},
"certificateUri": "https://fp-keyos.licensekeyserver.com/cert/5c17272389ed73211b673404f986ad24.der",
"certificateHeaders": {"customeheader": "customdata"
}
}
},
"sources": [{"src": "http://od101.cdn.lbcdn.com/vod/_definst_/mp4:vod/A_M_LCE/204_Alf_Mabrook.mp4/chunklist.m3u8?hdnts=ip=178.74.85.6~exp=1534590178482~acl=*~data=5a0d371bf6f3c100011545c8~hmac=43f27318be0700941ff08a7c561d364c241730084c4d0d98d4aa99298640d7dd",
"priority": 10,
"protocol": "HTTP",
"ttl": 3600
}
],
"ads": {"vastUrl": "http://v.lkqd.net/ad?pid=9&sid=977875&output=vastvpaid&support=html5&execution=any&placement=&playinit=auto&volume=100&&contentid=5915c3cdfc819813c4c22bfd&contenttitle=jordannoor",
"provider": "adsense",
"options": { }
}
}
]

Tv Show Trailer v3

Authorizations:

JWT

Responses

Response samples

200
451

Content type

application/json

{"screenRatio": 1.3333333730697632,
"volume": 100,
"description": "some description",
"runtime": 6000,
"name": "A_M_LCE/204_Alf_Mabrook.mp4",
"status": "ACTIVE",
"type": "HLS",
"sources": [{"src": "http://od101.cdn.lbcdn.com/vod/_definst_/mp4:vod/A_M_LCE/204_Alf_Mabrook.mp4/chunklist.m3u8?hdnts=ip=178.74.85.6~exp=1534590178482~acl=*~data=5a0d371bf6f3c100011545c8~hmac=43f27318be0700941ff08a7c561d364c241730084c4d0d98d4aa99298640d7dd",
"priority": 10,
"protocol": "HTTP",
"ttl": 3600
}
]
}

Tv Show / Season Trailer v3

Authorizations:

JWT

Responses

Response samples

200
451

Content type

application/json

{"screenRatio": 1.3333333730697632,
"volume": 100,
"description": "some description",
"runtime": 6000,
"name": "A_M_LCE/204_Alf_Mabrook.mp4",
"status": "ACTIVE",
"type": "HLS",
"sources": [{"src": "http://od101.cdn.lbcdn.com/vod/_definst_/mp4:vod/A_M_LCE/204_Alf_Mabrook.mp4/chunklist.m3u8?hdnts=ip=178.74.85.6~exp=1534590178482~acl=*~data=5a0d371bf6f3c100011545c8~hmac=43f27318be0700941ff08a7c561d364c241730084c4d0d98d4aa99298640d7dd",
"priority": 10,
"protocol": "HTTP",
"ttl": 3600
}
]
}

Tv Show / Episode Trailer v3

Authorizations:

JWT

Responses

Response samples

200
451

Content type

application/json

{"screenRatio": 1.3333333730697632,
"volume": 100,
"description": "some description",
"runtime": 6000,
"name": "A_M_LCE/204_Alf_Mabrook.mp4",
"status": "ACTIVE",
"type": "HLS",
"sources": [{"src": "http://od101.cdn.lbcdn.com/vod/_definst_/mp4:vod/A_M_LCE/204_Alf_Mabrook.mp4/chunklist.m3u8?hdnts=ip=178.74.85.6~exp=1534590178482~acl=*~data=5a0d371bf6f3c100011545c8~hmac=43f27318be0700941ff08a7c561d364c241730084c4d0d98d4aa99298640d7dd",
"priority": 10,
"protocol": "HTTP",
"ttl": 3600
}
]
}

TV Show Related

Responses

Response samples

200

Content type

application/json

[{"_id": "5915c3bacc8e1e13969de081",
"type": "TV_SHOW",
"title": "Alf Mabrook",
"plot": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"plotSimple": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"year": 2009,
"rating": 0.800000011920929,
"mpaaRating": "G",
"producers": ["Kamel Abu Ali",
"Mohamed Almanadely"
],
"directors": ["Ahmad Nader Jalal",
"Ahmad Jalal"
],
"screenshots": [{"_id": null,
"width": null,
"height": null,
"path": null,
"title": null
}
],
"trailers": [{"_id": "5915c3bbcc8e1e13969de2d9",
"title": "Trailer",
"image": {"_id": null,
"width": null,
"height": null,
"path": null,
"title": null
},
"description": "some description",
"runtime": 3600,
"name": "A_M_LCE/202_Zoag_Taht_El_Talab.mp4",
"status": "ACTIVE",
"screenRatio": 1.3333333730697632,
"volume": 100
}
],
"cast": [{"_id": "5915c3bacc8e1e13969de086",
"name": "Ahmad Jalal"
},
{"_id": "5915c3bacc8e1e13969de087",
"name": "Ahmad Nader Jalal"
}
],
"genres": ["5915c3ec201c2313ee14cb70"
],
"categories": ["5915c3941d6d2f134d699da3"
],
"countries": ["ARE"
],
"languages": ["ara"
],
"seasons": [{"_id": "5915c3bacc8e1e13969de081",
"type": "TV_SHOW_SEASON",
"title": "Alf Mabrook",
"plot": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"plotSimple": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"year": 2009,
"rating": 0.800000011920929,
"mpaaRating": "G",
"producers": ["Kamel Abu Ali",
"Mohamed Almanadely"
],
"directors": ["Ahmad Nader Jalal",
"Ahmad Jalal"
],
"screenshots": [{"_id": null,
"width": null,
"height": null,
"path": null,
"title": null
}
],
"trailers": [{"_id": "5915c3bbcc8e1e13969de2d9",
"title": "Trailer",
"image": {"_id": null,
"width": null,
"height": null,
"path": null,
"title": null
},
"description": "some description",
"runtime": 3600,
"name": "A_M_LCE/202_Zoag_Taht_El_Talab.mp4",
"status": "ACTIVE",
"screenRatio": 1.3333333730697632,
"volume": 100
}
],
"cast": [{"_id": "5915c3bacc8e1e13969de086",
"name": "Ahmad Jalal"
},
{"_id": "5915c3bacc8e1e13969de087",
"name": "Ahmad Nader Jalal"
}
],
"genres": ["5915c3ec201c2313ee14cb70"
],
"categories": ["5915c3941d6d2f134d699da3"
],
"countries": ["ARE"
],
"languages": ["ara"
]
}
]
}
]

TV Show Categories

Responses

Response samples

200

Content type

application/json

[{"_id": "592672a1b7fb245a4e417c0b",
"title": "Arabic Movies",
"description": "Some description",
"order": 1,
"rating": 0.694526195526123,
"posters": [{"_id": "592672a1b7fb245a4e417c0b",
"title": "Arabic Movies",
"path": "category-poster/5922f5aeb7fb245a4e400291.PNG",
"width": 160,
"height": 160
}
],
"backgrounds": [{"_id": "592672a1b7fb245a4e417c0b",
"title": "Arabic Movies",
"path": "category-poster/5922f5aeb7fb245a4e400291.PNG",
"width": 160,
"height": 160
}
]
}
]

TV Show Languages

Examples:

Default: /client/api/servicespec/59e5b5c4a95efa0001e28e2d/tv-show/languages
Posters: /client/api/servicespec/59e5b5c4a95efa0001e28e2d/tv-show/languages?posters
Cards: /client/api/servicespec/59e5b5c4a95efa0001e28e2d/tv-show/languages?cards

Responses

Response samples

200

Content type

application/json

[{"_id": "bul",
"name": "Bulgarian",
"order": 1,
"images": [{"_id": "5a4f232959cc7d08a23d76b2",
"title": "poster",
"path": "language-image/poster-ara.png"
}
]
}
]

TV Show Genres

Responses

Response samples

200

Content type

application/json

[{"_id": "5915c3ec201c2313ee14cb70",
"title": "Arabic Comedy",
"description": "Some description",
"order": 1,
"rating": 0.9526172876358032,
"posters": [{"_id": "592672a1b7fb245a4e417c0b",
"title": "Arabic Movies",
"path": "category-poster/5922f5aeb7fb245a4e400291.PNG",
"width": 160,
"height": 160
}
],
"backgrounds": [{"_id": "592672a1b7fb245a4e417c0b",
"title": "Arabic Movies",
"path": "category-poster/5922f5aeb7fb245a4e400291.PNG",
"width": 160,
"height": 160
}
]
}
]

TV Show Countries

Examples:

Default: /client/api/servicespec/5915c39c1d6d2f134d69afb1/tv-show/countries
Posters: /client/api/servicespec/5915c39c1d6d2f134d69afb1/tv-show/countries?posters
Cards: /client/api/servicespec/5915c39c1d6d2f134d69afb1/tv-show/countries?cards

Responses

Response samples

200

Content type

application/json

[{"_id": "GRC",
"commonName": "Greece"
}
]

Tutorials

Returns Tutorials

Responses

Response samples

200
404

Content type

application/json

{"_id": "5915c3bacc8e1e13969de081",
"title": "Tutorial",
"tags": ["tutorial"
],
"languages": [{"_id": "5d1210a005042b000107c6bc",
"title": "English",
"number": 1,
"languages": ["eng"
],
"tutorials": [{"_id": "5d1210a005042b000107c6bc",
"title": "Home screen navigation",
"plotSimple": "Learn how to navigate the Home screen of the new EllasTV Smart TV User Interface using the arrow buttons and the OK button!",
"number": 1,
"languages": ["eng"
],
"posters": [{"_id": "592672a1b7fb245a4e417c0b",
"title": "Arabic Movies",
"path": "category-poster/5922f5aeb7fb245a4e400291.PNG",
"width": 160,
"height": 160
}
],
"backgrounds": [{"_id": "592672a1b7fb245a4e417c0b",
"title": "Arabic Movies",
"path": "category-poster/5922f5aeb7fb245a4e400291.PNG",
"width": 160,
"height": 160
}
]
}
]
}
]
}

Tutorial Source

Authorizations:

JWT

Responses

Response samples

200

Content type

application/json

[{"screenRatio": 1.3333333730697632,
"volume": 100,
"runtime": 6000,
"name": "A_M_LCE/204_Alf_Mabrook.mp4",
"status": "ACTIVE",
"type": "HLS",
"sources": [{"src": "http://od101.cdn.lbcdn.com/vod/_definst_/mp4:vod/A_M_LCE/204_Alf_Mabrook.mp4/chunklist.m3u8?hdnts=ip=178.74.85.6~exp=1534590178482~acl=*~data=5a0d371bf6f3c100011545c8~hmac=43f27318be0700941ff08a7c561d364c241730084c4d0d98d4aa99298640d7dd",
"priority": 10,
"protocol": "HTTP"
}
]
}
]

Radio

Returns a list of radio

Examples:

Brief & sort by rating & limit 20: /client/api/servicespec/59e5b5c4a95efa0001e28e2d/radio?brief&sort=-rating&limit=20
projection is default: /client/api/servicespec/59e5b5c4a95efa0001e28e2d/radio
projection is brief: /client/api/servicespec/59e5b5c4a95efa0001e28e2d/radio?brief
Search by title: /client/api/servicespec/59e5b5c4a95efa0001e28e2d/radio?title=/ARAB/i&sort=-rating
Pages:
- First 50: /client/api/servicespec/59e5b5c4a95efa0001e28e2d/radio
- 50-100: /client/api/servicespec/59e5b5c4a95efa0001e28e2d/radio?skip=50

query Parameters

title	string Example: title=/usa/i Search by title (regular expression)
plot	string Example: plot=/story of Alf Mabrook/i Search by plot (regular expression)
year	integer Example: year=2009 Search by year
languages	string Example: languages=5915c3941d6d2f134d699da3 Search by language ID
countries	string Example: countries=5915c3941d6d2f134d699da3 Search by country ID
genres	string Example: genres=5915c3941d6d2f134d699da3 Search by genre ID
categories	string Example: categories=5915c3941d6d2f134d699da3 Search by category ID
studios	string Example: studios=2009 TODO: fixme Search by studios (mongodb query)

Responses

Response samples

200

Content type

application/json

[{"_id": "5915c3bacc8e1e13969de081",
"title": "Alf Mabrook",
"plot": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"plotSimple": "The story of Alf Mabrook is adapted from the American comedy “Groundhog Day” which presents a comic scenario in a fantasy-filled context. The protagonist (Ahmad Helmi) finds himself in a bizarre situation where he wakes up every day to relive the same events over and over. Thus our hero finds himself stuck in a cycle without any apparent exit.",
"year": 2009,
"rating": 0.800000011920929,
"mpaaRating": "G",
"producers": ["Kamel Abu Ali",
"Mohamed Almanadely"
],
"directors": ["Ahmad Nader Jalal",
"Ahmad Jalal"
],
"cast": [{"_id": "5915c3bacc8e1e13969de086",
"name": "Ahmad Jalal"
},
{"_id": "5915c3bacc8e1e13969de087",
"name": "Ahmad Nader Jalal"
}
],
"posters": [{"path": "videotitle-poster/592624fcb7fb245a4e412021.PNG"
}
],
"backgrounds": [{"path": "videotitle-poster/592624fcb7fb245a4e412021.PNG"
}
],
"genres": ["5915c3ec201c2313ee14cb70"
],
"categories": ["5915c3941d6d2f134d699da3"
],
"countries": ["ARE"
],
"languages": ["ara"
]
}
]

Radio Source V3

Authorizations:

JWT

Responses

Response samples

200
451

Content type

application/json

[{"screenRatio": 1.3333333730697632,
"volume": 100,
"description": "some description",
"runtime": 6000,
"name": "A_M_LCE/204_Alf_Mabrook.mp4",
"status": "ACTIVE",
"type": "HLS",
"drm": {"types": ["WIDEVINE",
"PLAYREADY"
],
"ttl": 43200,
"WIDEVINE": {"licenseUri": "https://wv-keyos.licensekeyserver.com/",
"licenseHeaders": {"customdata": "PEtleU9TQXV0aGVudGljYXRpb25YTUw+IDxEYXRhPiAgIDxHZW5lcmF0aW9uVGltZT4yMDE5LTA1LTA0IDExOjEwOjUzLjkwMzwvR2VuZXJhdGlvblRpbWU+ICAgPEV4cGlyYXRpb25UaW1lPjwvRXhwaXJhdGlvblRpbWU+ICAgPFVuaXF1ZUlkPjFlNTZmOGJkLTQyYTAtNDlmZC05MzAwLTVlNjk0OWJhMTlmYzwvVW5pcXVlSWQ+ICAgPFJTQVB1YktleUlkPjVjMTcyNzIzODllZDczMjExYjY3MzQwNGY5ODZhZDI0PC9SU0FQdWJLZXlJZD4gICA8V2lkZXZpbmVQb2xpY3kgZmxfQ2FuUGxheT0idHJ1ZSIgZmxfQ2FuUGVyc2lzdD0iZmFsc2UiIC8+ICAgPFdpZGV2aW5lQ29udGVudEtleVNwZWMgVHJhY2tUeXBlPSJIRCI+ICAgICA8U2VjdXJpdHlMZXZlbD4xPC9TZWN1cml0eUxldmVsPiAgIDwvV2lkZXZpbmVDb250ZW50S2V5U3BlYz4gICA8RmFpclBsYXlQb2xpY3kgcGVyc2lzdGVudD0iZmFsc2UiIC8+ICAgPExpY2Vuc2UgdHlwZT0ic2ltcGxlIiAvPiA8L0RhdGE+IDxTaWduYXR1cmU+ZGhjWWRNL25NL0FLekFFMEg2bHhFT00vMldqN3djUWo0UGtXNTdzY1Jhd0VDRU5WcnpWRXgxc1ZPNk9RNVpweDJQM0thOWhIcVllbDlMYThyMHRnelhVRFRNSU9acHVxYnM1UWxZenJPRmg5N1VHOGI4a2tWYUw4VHVwdVBOcHlCdmlTQXlSUEsydDlTVmppNkw2OXAzT0NvdUcyOHRmT0wrQlhVSUtMS2MwQldacE1IUmNYYnZPQjk1UHVlS1VoaUUraWUzWjJpUDhkYnA5MHAvc2JsdWthaE1PUzlmbkpIZ084U3psckhxUEtBTkQyRWVLTFdYQUg1UHNielJsNHhPcUQzS2kwdlBDd2FJTHIrLzhJT3J1TmJ4aWIrQ1Q1UFI4OVBQOUw1bzc5Z1g4Ym56Zktud1RNUUpOSTlIRHlxTTNMczdyeEFCNVZIdnI2cE51R0l3JiN4M0Q7JiN4M0Q7PC9TaWduYXR1cmU+IDwvS2V5T1NBdXRoZW50aWNhdGlvblhNTD4&#x3D;"
}
},
"PLAYREADY": {"licenseUri": "https://pr-keyos.licensekeyserver.com/core/rightsmanager.asmx",
"licenseHeaders": {"customdata": "PEtleU9TQXV0aGVudGljYXRpb25YTUw+IDxEYXRhPiAgIDxHZW5lcmF0aW9uVGltZT4yMDE5LTA1LTA0IDExOjEwOjUzLjkwMzwvR2VuZXJhdGlvblRpbWU+ICAgPEV4cGlyYXRpb25UaW1lPjwvRXhwaXJhdGlvblRpbWU+ICAgPFVuaXF1ZUlkPjFlNTZmOGJkLTQyYTAtNDlmZC05MzAwLTVlNjk0OWJhMTlmYzwvVW5pcXVlSWQ+ICAgPFJTQVB1YktleUlkPjVjMTcyNzIzODllZDczMjExYjY3MzQwNGY5ODZhZDI0PC9SU0FQdWJLZXlJZD4gICA8V2lkZXZpbmVQb2xpY3kgZmxfQ2FuUGxheT0idHJ1ZSIgZmxfQ2FuUGVyc2lzdD0iZmFsc2UiIC8+ICAgPFdpZGV2aW5lQ29udGVudEtleVNwZWMgVHJhY2tUeXBlPSJIRCI+ICAgICA8U2VjdXJpdHlMZXZlbD4xPC9TZWN1cml0eUxldmVsPiAgIDwvV2lkZXZpbmVDb250ZW50S2V5U3BlYz4gICA8RmFpclBsYXlQb2xpY3kgcGVyc2lzdGVudD0iZmFsc2UiIC8+ICAgPExpY2Vuc2UgdHlwZT0ic2ltcGxlIiAvPiA8L0RhdGE+IDxTaWduYXR1cmU+ZGhjWWRNL25NL0FLekFFMEg2bHhFT00vMldqN3djUWo0UGtXNTdzY1Jhd0VDRU5WcnpWRXgxc1ZPNk9RNVpweDJQM0thOWhIcVllbDlMYThyMHRnelhVRFRNSU9acHVxYnM1UWxZenJPRmg5N1VHOGI4a2tWYUw4VHVwdVBOcHlCdmlTQXlSUEsydDlTVmppNkw2OXAzT0NvdUcyOHRmT0wrQlhVSUtMS2MwQldacE1IUmNYYnZPQjk1UHVlS1VoaUUraWUzWjJpUDhkYnA5MHAvc2JsdWthaE1PUzlmbkpIZ084U3psckhxUEtBTkQyRWVLTFdYQUg1UHNielJsNHhPcUQzS2kwdlBDd2FJTHIrLzhJT3J1TmJ4aWIrQ1Q1UFI4OVBQOUw1bzc5Z1g4Ym56Zktud1RNUUpOSTlIRHlxTTNMczdyeEFCNVZIdnI2cE51R0l3JiN4M0Q7JiN4M0Q7PC9TaWduYXR1cmU+IDwvS2V5T1NBdXRoZW50aWNhdGlvblhNTD4&#x3D;"
}
},
"FAIRPLAY": {"licenseUri": "https://fp-keyos.licensekeyserver.com/getkey",
"licenseHeaders": {"customdata": "PEtleU9TQXV0aGVudGljYXRpb25YTUw+IDxEYXRhPiAgIDxHZW5lcmF0aW9uVGltZT4yMDE5LTA1LTA0IDExOjEwOjUzLjkwMzwvR2VuZXJhdGlvblRpbWU+ICAgPEV4cGlyYXRpb25UaW1lPjwvRXhwaXJhdGlvblRpbWU+ICAgPFVuaXF1ZUlkPjFlNTZmOGJkLTQyYTAtNDlmZC05MzAwLTVlNjk0OWJhMTlmYzwvVW5pcXVlSWQ+ICAgPFJTQVB1YktleUlkPjVjMTcyNzIzODllZDczMjExYjY3MzQwNGY5ODZhZDI0PC9SU0FQdWJLZXlJZD4gICA8V2lkZXZpbmVQb2xpY3kgZmxfQ2FuUGxheT0idHJ1ZSIgZmxfQ2FuUGVyc2lzdD0iZmFsc2UiIC8+ICAgPFdpZGV2aW5lQ29udGVudEtleVNwZWMgVHJhY2tUeXBlPSJIRCI+ICAgICA8U2VjdXJpdHlMZXZlbD4xPC9TZWN1cml0eUxldmVsPiAgIDwvV2lkZXZpbmVDb250ZW50S2V5U3BlYz4gICA8RmFpclBsYXlQb2xpY3kgcGVyc2lzdGVudD0iZmFsc2UiIC8+ICAgPExpY2Vuc2UgdHlwZT0ic2ltcGxlIiAvPiA8L0RhdGE+IDxTaWduYXR1cmU+ZGhjWWRNL25NL0FLekFFMEg2bHhFT00vMldqN3djUWo0UGtXNTdzY1Jhd0VDRU5WcnpWRXgxc1ZPNk9RNVpweDJQM0thOWhIcVllbDlMYThyMHRnelhVRFRNSU9acHVxYnM1UWxZenJPRmg5N1VHOGI4a2tWYUw4VHVwdVBOcHlCdmlTQXlSUEsydDlTVmppNkw2OXAzT0NvdUcyOHRmT0wrQlhVSUtMS2MwQldacE1IUmNYYnZPQjk1UHVlS1VoaUUraWUzWjJpUDhkYnA5MHAvc2JsdWthaE1PUzlmbkpIZ084U3psckhxUEtBTkQyRWVLTFdYQUg1UHNielJsNHhPcUQzS2kwdlBDd2FJTHIrLzhJT3J1TmJ4aWIrQ1Q1UFI4OVBQOUw1bzc5Z1g4Ym56Zktud1RNUUpOSTlIRHlxTTNMczdyeEFCNVZIdnI2cE51R0l3JiN4M0Q7JiN4M0Q7PC9TaWduYXR1cmU+IDwvS2V5T1NBdXRoZW50aWNhdGlvblhNTD4&#x3D;"
},
"certificateUri": "https://fp-keyos.licensekeyserver.com/cert/5c17272389ed73211b673404f986ad24.der",
"certificateHeaders": {"customeheader": "customdata"
}
}
},
"sources": [{"src": "http://od101.cdn.lbcdn.com/vod/_definst_/mp4:vod/A_M_LCE/204_Alf_Mabrook.mp4/chunklist.m3u8?hdnts=ip=178.74.85.6~exp=1534590178482~acl=*~data=5a0d371bf6f3c100011545c8~hmac=43f27318be0700941ff08a7c561d364c241730084c4d0d98d4aa99298640d7dd",
"priority": 10,
"protocol": "HTTP",
"ttl": 3600
}
],
"ads": {"vastUrl": "http://v.lkqd.net/ad?pid=9&sid=977875&output=vastvpaid&support=html5&execution=any&placement=&playinit=auto&volume=100&&contentid=5915c3cdfc819813c4c22bfd&contenttitle=jordannoor",
"provider": "adsense",
"options": { }
}
}
]

Radio Categories

Responses

Response samples

200

Content type

application/json

[{"_id": "592672a1b7fb245a4e417c0b",
"title": "Arabic Movies",
"description": "Some description",
"order": 1,
"rating": 0.694526195526123,
"posters": [{"_id": "592672a1b7fb245a4e417c0b",
"title": "Arabic Movies",
"path": "category-poster/5922f5aeb7fb245a4e400291.PNG",
"width": 160,
"height": 160
}
],
"backgrounds": [{"_id": "592672a1b7fb245a4e417c0b",
"title": "Arabic Movies",
"path": "category-poster/5922f5aeb7fb245a4e400291.PNG",
"width": 160,
"height": 160
}
]
}
]

Radio Languages

Examples:

Default: /client/api/servicespec/59e5b5c4a95efa0001e28e2d/radio/languages
Posters: /client/api/servicespec/59e5b5c4a95efa0001e28e2d/radio/languages?posters
Cards: /client/api/servicespec/59e5b5c4a95efa0001e28e2d/radio/languages?cards

Responses

Response samples

200

Content type

application/json

[{"_id": "bul",
"name": "Bulgarian",
"order": 1,
"images": [{"_id": "5a4f232959cc7d08a23d76b2",
"title": "poster",
"path": "language-image/poster-ara.png"
}
]
}
]

Radio Genres

Responses

Response samples

200

Content type

application/json

[{"_id": "5915c3ec201c2313ee14cb70",
"title": "Arabic Comedy",
"description": "Some description",
"order": 1,
"rating": 0.9526172876358032,
"posters": [{"_id": "592672a1b7fb245a4e417c0b",
"title": "Arabic Movies",
"path": "category-poster/5922f5aeb7fb245a4e400291.PNG",
"width": 160,
"height": 160
}
],
"backgrounds": [{"_id": "592672a1b7fb245a4e417c0b",
"title": "Arabic Movies",
"path": "category-poster/5922f5aeb7fb245a4e400291.PNG",
"width": 160,
"height": 160
}
]
}
]

Radio Countries

Examples:

Default: /client/api/servicespec/5915c39c1d6d2f134d69afb1/radio/countries
Posters: /client/api/servicespec/5915c39c1d6d2f134d69afb1/radio/countries?posters
Cards: /client/api/servicespec/5915c39c1d6d2f134d69afb1/radio/countries?cards

Responses

Response samples

200

Content type

application/json

[{"_id": "GRC",
"commonName": "Greece"
}
]

Promos

Returns promos for `STB` Device type Deprecated

Responses

Response samples

200

Content type

application/json

[{"_id": "5923e31fb7fb245a4e40263a",
"title": "AlphaOTT OS v2.0",
"subtitle": "New design, updated, faster and better than ever!",
"description": "New design, updated. Faster and better than ever!",
"order": 1,
"type": "NAVIGATE",
"activated": "2017-05-12T14:16:27.134Z",
"images": [{"path": "promo-poster/592624fcb7fb245a4e412021.PNG"
}
],
"backgrounds": [{"path": "promo-poster/592624fcb7fb245a4e412021.PNG"
}
],
"options": [{"_id": "query",
"value": "action=tv.recent/catalog"
}
]
}
]

Returns promos for certain Device type

Examples:

Sort by contentType & deviceType: /client/api/v2/servicespec/5d1daa05dd849c0001419008/promos?deviceType=UNKNOWN&contentType=TV_SHOW,RADIO
Sort by deviceType: /client/api/v2/servicespec/5d1daa05dd849c0001419008/promos?deviceType=UNKNOWN

Summary about ContentType:

if there is NO query param contentType , everything will works as usual
if there is query param contentType:
- ALL - returns all banners with non-empty contentType field
- TV_SHOW, APP, MOVIE, RADIO, TV - returns filtered banners

Note: queries contentType=ALL,TV && contentType=ALL returns the same result

Responses

Response samples

200

Content type

application/json

[{"_id": "5923e31fb7fb245a4e40263a",
"title": "AlphaOTT OS v2.0",
"subtitle": "New design, updated, faster and better than ever!",
"description": "New design, updated. Faster and better than ever!",
"order": 1,
"type": "NAVIGATE",
"contentType": ["TV"
],
"activated": "2017-05-12T14:16:27.134Z",
"images": [{"path": "promo-poster/592624fcb7fb245a4e412021.PNG"
}
],
"backgrounds": [{"path": "promo-poster/592624fcb7fb245a4e412021.PNG"
}
],
"options": {"path": "main/menu",
"query": "action=tv.recent/catalog/tv.languages/ara",
"action": {"id": "592624fcb7fb245a4e412021",
"button": {"text": "WATCH NOW!"
}
},
"description": {"color": "#FFFFFF"
}
}
}
]

Subscriptions

Cancel a subscription

Authorizations:

JWT

path Parameters

subscriptionId

required

string

Example: 5d420595405267002f72d833

Subscription ID

query Parameters

cancelAtEnd

boolean

Default: true

Your subscription can be either cancelled immediately or at the end of the current term based on the value of cancelAtEnd.

Responses

Response samples

200
400

Content type

application/json

{"status": "OK",
"message": "Your subscription will be canceled at the end of this term."
}